| java.lang.Object
 java.io.Writer
All known Subclasses: java.io.PipedWriter, java.io.CharArrayWriter, java.io.PrintWriter, java.io.FilterWriter, java.io.StringWriter, java.io.OutputStreamWriter, java.io.BufferedWriter,
| Writer | | abstract public class Writer implements Appendable,Closeable,Flushable(Code) | | Abstract class for writing to character streams. The only methods that a
subclass must implement are write(char[], int, int), flush(), and close().
Most subclasses, however, will override some of the methods defined here in
order to provide higher efficiency, additional functionality, or both.
See Also: Writer
See Also: BufferedWriter
See Also: CharArrayWriter
See Also: FilterWriter
See Also: OutputStreamWriter
See Also: FileWriter
See Also: PipedWriter
See Also: PrintWriter
See Also: StringWriter
See Also: Reader
version:
1.35, 07/05/05
author:
Mark Reinhold
since:
JDK1.1 |
| Field Summary | |
| protected Object | lock
The object used to synchronize operations on this stream. |
| Constructor Summary | |
| protected | Writer()
Creates a new character-stream writer whose critical sections will
synchronize on the writer itself. | | protected | Writer(Object lock)
Creates a new character-stream writer whose critical sections will
synchronize on the given object. |
| Method Summary | |
| public Writer | 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. | | public Writer | append(CharSequence csq, int start, int end)
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
out.write(csq.subSequence(start, end).toString())
Parameters:
csq - The character sequence from which a subsequence will beappended. | | public Writer | append(char c)
Appends the specified character to this writer. | | abstract public void | close()
Closes the stream, flushing it first. | | abstract public void | flush()
Flushes the stream. | | public void | write(int c)
Writes a single character. | | public void | write(char cbuf)
Writes an array of characters. | | abstract public void | write(char cbuf, int off, int len)
Writes a portion of an array of characters. | | public void | write(String str)
Writes a string. | | public void | write(String str, int off, int len)
Writes a portion of a string. |
| lock | | protected Object lock(Code) | | 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.
|
| Writer | | protected Writer()(Code) | | Creates a new character-stream writer whose critical sections will
synchronize on the writer itself.
|
| Writer | | protected Writer(Object lock)(Code) | | Creates a new character-stream writer whose critical sections will
synchronize on the given object.
Parameters:
lock - Object to synchronize on |
| append | | public Writer append(CharSequence csq) throws IOException(Code) | | 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:
csq - The character sequence to append. If csq isnull, then the four characters "null" areappended to this writer. This writer
throws:
IOException - If an I/O error occurs
since:
1.5 |
| append | | public Writer append(CharSequence csq, int start, int end) throws IOException(Code) | | 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
out.write(csq.subSequence(start, end).toString())
Parameters:
csq - The character sequence from which a subsequence will beappended. If csq is null, then characterswill be appended as if csq contained the fourcharacters "null".
Parameters:
start - The index of the first character in the subsequence
Parameters:
end - The index of the character following the last character in thesubsequence This writer
throws:
IndexOutOfBoundsException - If start or end are negative, startis greater than end, or end is greater thancsq.length()
throws:
IOException - If an I/O error occurs
since:
1.5 |
| append | | public Writer append(char c) throws IOException(Code) | | 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:
c - The 16-bit character to append This writer
throws:
IOException - If an I/O error occurs
since:
1.5 |
| close | | abstract public void close() throws IOException(Code) | | Closes the stream, flushing it first. Once the stream has been closed,
further write() or flush() invocations will cause an IOException to be
thrown. Closing a previously closed stream has no effect.
throws:
IOException - If an I/O error occurs |
| flush | | abstract public void flush() throws IOException(Code) | | Flushes the stream. If the stream has saved any characters from the
various write() methods in a buffer, write them immediately to their
intended destination. Then, if that destination is another character or
byte stream, flush it. Thus one flush() invocation will flush all the
buffers in a chain of Writers and OutputStreams.
If the intended destination of this stream is an abstraction provided
by the underlying operating system, for example a file, then flushing the
stream guarantees only that bytes previously written to the stream are
passed to the operating system for writing; it does not guarantee that
they are actually written to a physical device such as a disk drive.
throws:
IOException - If an I/O error occurs |
| write | | public void write(int c) throws IOException(Code) | | Writes a single character. The character to be written is contained in
the 16 low-order bits of the given integer value; the 16 high-order bits
are ignored.
Subclasses that intend to support efficient single-character output
should override this method.
Parameters:
c - int specifying a character to be written
throws:
IOException - If an I/O error occurs |
| write | | public void write(char cbuf) throws IOException(Code) | | Writes an array of characters.
Parameters:
cbuf - Array of characters to be written
throws:
IOException - If an I/O error occurs |
| write | | abstract public void write(char cbuf, int off, int len) throws IOException(Code) | | Writes a portion of an array of characters.
Parameters:
cbuf - Array of characters
Parameters:
off - Offset from which to start writing characters
Parameters:
len - Number of characters to write
throws:
IOException - If an I/O error occurs |
| write | | public void write(String str, int off, int len) throws IOException(Code) | | Writes a portion of a string.
Parameters:
str - A String
Parameters:
off - Offset from which to start writing characters
Parameters:
len - Number of characters to write
throws:
IndexOutOfBoundsException - If off is negative, or len is negative,or off+len is negative or greater than the lengthof the given string
throws:
IOException - If an I/O error occurs |
|
|