FilterWriter
abstract class FilterWriter : Writer
Abstract class for writing filtered character streams. The abstract class FilterWriter
itself provides default methods that pass all requests to the contained stream. Subclasses of FilterWriter
should override some of these methods and may also provide additional methods and fields.
Summary
Protected constructors |
Create a new filtered writer.
|
Public methods |
open Unit |
|
open Unit |
Flushes the stream.
|
open Unit |
Writes a single character.
|
open Unit |
Writes a portion of an array of characters.
|
open Unit |
Writes a portion of a string.
|
Inherited functions |
From class Writer
Writer |
append(csq: CharSequence?)
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.
|
Writer |
append(csq: CharSequence?, start: Int, end: Int)
Appends a subsequence of the specified character sequence to this writer. Appendable .
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
<code>out.write(csq.subSequence(start, end).toString())
</code>
|
Writer |
append(c: Char)
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)
|
Writer! |
nullWriter()
Returns a new Writer which discards all characters. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.
While the stream is open, the append(char) , append(CharSequence) , append(CharSequence, int, int) , flush() , write(int) , write(char[]) , and write(char[], int, int) methods do nothing. After the stream has been closed, these methods all throw IOException .
The object used to synchronize operations on the returned Writer is not specified.
|
Unit |
write(cbuf: CharArray!)
Writes an array of characters.
|
Unit |
write(str: String!)
Writes a string.
|
|
Properties |
Writer! |
The underlying character-output stream.
|
Inherited properties |
From class Writer
Any! |
lock
The object used to synchronize operations on this stream. For efficiency, a character-stream object may use an object other than itself to protect critical sections. A subclass should therefore use the object in this field rather than this or a synchronized method.
|
|
Protected constructors
FilterWriter
protected FilterWriter(out: Writer!)
Create a new filtered writer.
Parameters |
out |
Writer!: a Writer object to provide the underlying stream. |
Exceptions |
java.lang.NullPointerException |
if out is null |
Public methods
close
open fun close(): Unit
Exceptions |
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
If an I/O error occurs |
flush
open fun flush(): Unit
Flushes the stream.
Exceptions |
java.io.IOException |
If an I/O error occurs |
java.io.IOException |
If an I/O error occurs |
write
open fun write(c: Int): Unit
Writes a single character.
Parameters |
c |
Int: int specifying a character to be written |
Exceptions |
java.io.IOException |
If an I/O error occurs |
java.io.IOException |
If an I/O error occurs |
write
open fun write(
cbuf: CharArray!,
off: Int,
len: Int
): Unit
Writes a portion of an array of characters.
Parameters |
cbuf |
CharArray!: Buffer of characters to be written |
off |
Int: Offset from which to start reading characters |
len |
Int: Number of characters to be written |
Exceptions |
java.lang.IndexOutOfBoundsException |
If the values of the off and len parameters cause the corresponding method of the underlying Writer to throw an IndexOutOfBoundsException |
java.io.IOException |
If an I/O error occurs |
write
open fun write(
str: String!,
off: Int,
len: Int
): Unit
Writes a portion of a string.
Parameters |
str |
String!: String to be written |
off |
Int: Offset from which to start reading characters |
len |
Int: Number of characters to be written |
Exceptions |
java.lang.IndexOutOfBoundsException |
If the values of the off and len parameters cause the corresponding method of the underlying Writer to throw an IndexOutOfBoundsException |
java.io.IOException |
If an I/O error occurs |
Properties
out
protected var out: Writer!
The underlying character-output stream.