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.
protected char[] buf
The buffer where data is stored.
protected int count
The number of chars in the buffer.
public CharArrayWriter()
Creates a new CharArrayWriter.
public CharArrayWriter(int initialSize)
Creates a new CharArrayWriter with the specified initial size.
initialSize
- an int specifying the initial buffer size.IllegalArgumentException
- if initialSize is negativepublic void write(int c)
Writes a character to the buffer.
public void write(char[] c, int off, int len)
Writes characters to the buffer.
write
in class Writer
c
- the data to be writtenoff
- the start offset in the datalen
- the number of chars that are writtenpublic void write(String str, int off, int len)
Write a portion of a string to the buffer.
write
in class Writer
str
- String to be written fromoff
- Offset from which to start reading characterslen
- Number of characters to be writtenpublic void writeTo(Writer out) throws IOException
Writes the contents of the buffer to another character stream.
out
- the output stream to write toIOException
- If an I/O error occurs.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.
append
in interface Appendable
append
in class Writer
csq
- The character sequence to append. If csq
is null
, then the four characters "null"
are appended to this writer.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())
append
in interface Appendable
append
in class Writer
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"
.start
- The index of the first character in the subsequenceend
- The index of the character following the last character in the subsequenceIndexOutOfBoundsException
- If start
or end
are negative, start
is greater than end
, or end
is greater than csq.length()
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)
append
in interface Appendable
append
in class Writer
c
- The 16-bit character to appendpublic void reset()
Resets the buffer so that you can use it again without throwing away the already allocated buffer.
public char[] toCharArray()
Returns a copy of the input data.
public int size()
Returns the current size of the buffer.
public String toString()
Converts input data to a string.
public void flush()
Flush the stream.
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.
close
in interface Closeable
close
in interface AutoCloseable
close
in class Writer
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.