Class CharArrayWriter
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
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.
- Since:
- 1.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected char[]The buffer where data is stored.protected intThe number of chars in the buffer. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new CharArrayWriter.CharArrayWriter(int initialSize) Creates a new CharArrayWriter with the specified initial size. -
Method Summary
Modifier and TypeMethodDescriptionappend(char c) Appends the specified character to this writer.append(CharSequence csq) Appends the specified character sequence to this writer.append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.voidclose()Close the stream.voidflush()Flush the stream.voidreset()Resets the buffer so that you can use it again without throwing away the already allocated buffer.intsize()Returns the current size of the buffer.char[]Returns a copy of the input data.toString()Converts input data to a string.voidwrite(char[] c, int off, int len) Writes characters to the buffer.voidwrite(int c) Writes a character to the buffer.voidWrite a portion of a string to the buffer.voidWrites the contents of the buffer to another character stream.Methods declared in class java.io.Writer
nullWriter, write, write
-
Field Details
-
buf
protected char[] bufThe buffer where data is stored. -
count
protected int countThe number of chars in the buffer.
-
-
Constructor Details
-
CharArrayWriter
public CharArrayWriter()Creates a new CharArrayWriter. -
CharArrayWriter
public CharArrayWriter(int initialSize) Creates a new CharArrayWriter with the specified initial size.- Parameters:
initialSize- an int specifying the initial buffer size.- Throws:
IllegalArgumentException- if initialSize is negative
-
-
Method Details
-
write
-
write
public void write(char[] c, int off, int len) Writes characters to the buffer.- Specified by:
writein classWriter- Parameters:
c- the data to be writtenoff- the start offset in the datalen- the number of chars that are written- Throws:
IndexOutOfBoundsException- Ifoffis negative, orlenis negative, oroff + lenis negative or greater than the length of the given array
-
write
Write a portion of a string to the buffer.- Overrides:
writein classWriter- Parameters:
str- String to be written fromoff- Offset from which to start reading characterslen- Number of characters to be written- Throws:
IndexOutOfBoundsException- Ifoffis negative, orlenis negative, oroff + lenis negative or greater than the length of the given string
-
writeTo
Writes the contents of the buffer to another character stream.- Parameters:
out- the output stream to write to- Throws:
IOException- If an I/O error occurs.
-
append
Appends the specified character sequence to this writer.An invocation of this method of the form
out.append(csq)whencsqis notnull, behaves in exactly the same way as the invocationout.write(csq.toString())Depending on the specification of
toStringfor the character sequencecsq, the entire sequence may not be appended. For instance, invoking thetoStringmethod of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- The character sequence to append. Ifcsqisnull, then the four characters"null"are appended to this writer.- Returns:
- This writer
- Since:
- 1.5
-
append
Appends a subsequence of the specified character sequence to this writer.An invocation of this method of the form
out.append(csq, start, end)whencsqis notnull, behaves in exactly the same way as the invocationout.write(csq.subSequence(start, end).toString())- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- The character sequence from which a subsequence will be appended. Ifcsqisnull, then characters will be appended as ifcsqcontained 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 subsequence- Returns:
- This writer
- Throws:
IndexOutOfBoundsException- Ifstartorendare negative,startis greater thanend, orendis greater thancsq.length()- Since:
- 1.5
-
append
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 invocationout.write(c)- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
c- The 16-bit character to append- Returns:
- This writer
- Since:
- 1.5
-
reset
public void reset()Resets the buffer so that you can use it again without throwing away the already allocated buffer. -
toCharArray
public char[] toCharArray()Returns a copy of the input data.- Returns:
- an array of chars copied from the input data.
-
size
public int size()Returns the current size of the buffer.- Returns:
- an int representing the current size of the buffer.
-
toString
-
flush
-
close
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.
-