Class: java.io.CharArrayWriter

  • public class CharArrayWriter
  • extends Writer
This class implements a character buffer that can be used as an Writer. The buffer automatically grows when data is written to the stream. The data can be retrieved using toCharArray() and toString().

Note: Invoking close() on this class has no effect, and methods of this class can be called after the stream has closed without generating an IOException.

Authors:
@author Herb Jellinek
Since:
@since JDK1.1

Inheritance

Superclass tree: Implements:

Methods

  • CharArrayWritertop

    public CharArrayWriter()
    Creates a new CharArrayWriter.
    Related Links:
    Google Code Search
    Stack Overflow

  • CharArrayWritertop

    public CharArrayWriter(int initialSize)
    Creates a new CharArrayWriter with the specified initial size.
    Parameters:
    @param initialSize an int specifying the initial buffer size.
    Exceptions:
    @exception IllegalArgumentException if initialSize is negative
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public CharArrayWriter append(char c)
    Appends the specified character to this writer.

    An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation 

         out.write(c)
    Parameters:
    @param c The 16-bit character to append
    Return:
    @return This writer
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Override hierarchy:
    append from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public CharArrayWriter append(CharSequence csq)
    Appends the specified character sequence to this writer.

    An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation 

         out.write(csq.toString())

    Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

    Parameters:
    @param csq The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.
    Return:
    @return This writer
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Override hierarchy:
    append from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public CharArrayWriter append(CharSequence csq, int start, int end)
    Appends a subsequence of the specified character sequence to this writer.

    An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation 

         out.write(csq.subSequence(start, end).toString())
    Parameters:
    @param csq The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
    @param start The index of the first character in the subsequence
    @param end The index of the character following the last character in the subsequence
    Return:
    @return This writer
    Exceptions:
    @throws IndexOutOfBoundsException If start or end are negative, start is greater than end, or end is greater than csq.length()
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Override hierarchy:
    append from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close()
    Close the stream. This method does not release the buffer, since its contents might still be required. Note: Invoking this method in this class will have no effect.
    Specified by:
    close from Closeable
    Override hierarchy:
    close from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • flushtop

    public void flush()
    Flush the stream.
    Specified by:
    flush from Flushable
    Override hierarchy:
    flush from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • resettop

    public void reset()
    Resets the buffer so that you can use it again without throwing away the already allocated buffer.
    Related Links:
    Google Code Search
    Stack Overflow

  • sizetop

    public int size()
    Returns the current size of the buffer.
    Return:
    @return an int representing the current size of the buffer.
    Related Links:
    Google Code Search
    Stack Overflow

  • toCharArraytop

    public char[] toCharArray()
    Returns a copy of the input data.
    Return:
    @return an array of chars copied from the input data.
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Converts input data to a string.
    Return:
    @return the string.
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(int c)
    Writes a character to the buffer.
    Parameters:
    @param c int specifying a character to be written
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(String str, int off, int len)
    Write a portion of a string to the buffer.
    Parameters:
    @param str String to be written from
    @param off Offset from which to start reading characters
    @param len Number of characters to be written
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(char[] c, int off, int len)
    Writes characters to the buffer.
    Parameters:
    @param c the data to be written
    @param off the start offset in the data
    @param len the number of chars that are written
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • writeTotop

    public void writeTo(Writer out) throws IOException
    Writes the contents of the buffer to another character stream.
    Parameters:
    @param out the output stream to write to
    Exceptions:
    @throws IOException If an I/O error occurs.
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • buf

    protected char[] buf
    The buffer where data is stored.

  • count

    protected int count
    The number of chars in the buffer.