Package org.apache.commons.io.output
Class AppendableWriter<T extends Appendable>
java.lang.Object
java.io.Writer
org.apache.commons.io.output.AppendableWriter<T>
- Type Parameters:
T- The type of theAppendablewrapped by this AppendableWriter.
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
Writer implementation that writes the data to an
Appendable
Object.
For example, can be used with a StringBuilder
or StringBuffer.
- Since:
- 2.7
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionAppendableWriter(T appendable) Constructs a new instance with the specified appendable. -
Method Summary
Modifier and TypeMethodDescriptionappend(char c) Appends the specified character to the underlying appendable.append(CharSequence csq) Appends the specified character sequence to the underlying appendable.append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to the underlying appendable.voidclose()Closes the stream.voidflush()Flushes the stream.Gets the target appendable.voidwrite(char[] cbuf, int off, int len) Writes a portion of an array of characters to the underlying appendable.voidwrite(int c) Writes a character to the underlying appendable.voidWrites a portion of a String to the underlying appendable.
-
Constructor Details
-
AppendableWriter
Constructs a new instance with the specified appendable.- Parameters:
appendable- the appendable to write to
-
-
Method Details
-
append
Appends the specified character to the underlying appendable.- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
c- the character to append- Returns:
- this writer
- Throws:
IOException- upon error
-
append
Appends the specified character sequence to the underlying appendable.- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- the character sequence to append- Returns:
- this writer
- Throws:
IOException- upon error
-
append
Appends a subsequence of the specified character sequence to the underlying appendable.- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- the character sequence from which a subsequence will be appendedstart- 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:
IOException- upon error
-
close
Closes the stream. This implementation does nothing.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classWriter- Throws:
IOException- upon error
-
flush
Flushes the stream. This implementation does nothing.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classWriter- Throws:
IOException- upon error
-
getAppendable
Gets the target appendable.- Returns:
- the target appendable
-
write
Writes a portion of an array of characters to the underlying appendable.- Specified by:
writein classWriter- Parameters:
cbuf- an array with the characters to writeoff- offset from which to start writing characterslen- number of characters to write- Throws:
IOException- upon error
-
write
Writes a character to the underlying appendable.- Overrides:
writein classWriter- Parameters:
c- the character to write- Throws:
IOException- upon error
-
write
Writes a portion of a String to the underlying appendable.- Overrides:
writein classWriter- Parameters:
str- a stringoff- offset from which to start writing characterslen- number of characters to write- Throws:
IOException- upon error
-