StringWriter

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.io
Class StringWriter

    java.lang.Object
      java.io.Writer
          java.io.StringWriter

    public class StringWriter

extends Writer

A character stream that collects its output in a string buffer, which can then be used to construct a string.

Closing a `StringWriter` has no effect. The methods in this class can be called after the stream has been closed without generating an `IOException`.

Since:
  JDK1.1
Version:
  1.18, 00/02/02
Author:
  Mark Reinhold

Constructor Summary
`StringWriter()` Create a new string writer, using the default initial string-buffer size.
`StringWriter(int initialSize)` Create a new string writer, using the specified initial string-buffer size.

Method Summary
`void` | `close()` Closing a `StringWriter` has no effect.
`void` | `flush()` Flush the stream.
`StringBuffer` | `getBuffer()` Return the string buffer itself.
`String` | `toString()` Return the buffer's current value as a string.
`void` | `write(char[] cbuf, int off, int len)` Write a portion of an array of characters.
`void` | `write(int c)` Write a single character.
`void` | `write(String str)` Write a string.
`void` | `write(String str, int off, int len)` Write a portion of a string.

Methods inherited from class java.io.Writer
`write`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### StringWriter

    public StringWriter()

  Create a new string writer, using the default initial string-buffer size.

### StringWriter

    public StringWriter(int initialSize)

  Create a new string writer, using the specified initial string-buffer size.

  Parameters:
    `initialSize` - an int specifying the initial size of the buffer.

Method Detail

### write

    public void write(int c)

  Write a single character.

  Overrides:
    `write` in class `Writer`
  Parameters:
    `c` - int specifying a character to be written.

### write

    public void write(char[] cbuf,
                      int off,
                      int len)

  Write a portion of an array of characters.

  Specified by:
    `write` in class `Writer`
  Parameters:
    `cbuf` - Array of characters
    `off` - Offset from which to start writing characters
    `len` - Number of characters to write

### write

    public void write(String str)

  Write a string.

  Overrides:
    `write` in class `Writer`
  Parameters:
    `str` - String to be written

### write

    public void write(String str,
                      int off,
                      int len)

  Write a portion of a string.

  Overrides:
    `write` in class `Writer`
  Parameters:
    `str` - String to be written
    `off` - Offset from which to start writing characters
    `len` - Number of characters to write

### toString

    public String toString()

  Return the buffer's current value as a string.

  Overrides:
    `toString` in class `Object`
  Returns:
    a string representation of the object.

### getBuffer

    public StringBuffer getBuffer()

  Return the string buffer itself.

  Returns:
    StringBuffer holding the current buffer value.

### flush

    public void flush()

  Flush the stream.

  Specified by:
    `flush` in class `Writer`

### close

    public void close()
               throws IOException

  Closing a `StringWriter` has no effect. The methods in this class can be called after the stream has been closed without generating an `IOException`.

  Specified by:
    `close` in class `Writer`
  Throws:
    `IOException` - If an I/O error occurs

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD