Writer (Java 2 Platform SE 5.0) (original) (raw)

java.io

Class Writer

java.lang.Object extended by java.io.Writer

All Implemented Interfaces:

Closeable, Flushable, Appendable

Direct Known Subclasses:

BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintWriter, StringWriter

public abstract class Writer

extends Object

implements Appendable, Closeable, Flushable

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.

Since:

JDK1.1

Field Summary
protected Object	lock The object used to synchronize operations on this stream.

Constructor Summary
protected	Writer() Create a new character-stream writer whose critical sections will synchronize on the writer itself.
protected	Writer(Object lock) Create a new character-stream writer whose critical sections will synchronize on the given object.

Method Summary
Writer	append(char c) Appends the specified character to this writer.
Writer	append(CharSequence csq) Appends the specified character sequence to this writer.
Writer	[append](../../java/io/Writer.html#append%28java.lang.CharSequence, int, int%29)(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
abstract void	close() Close the stream, flushing it first.
abstract void	flush() Flush the stream.
void	write(char[] cbuf) Write an array of characters.
abstract void	[write](../../java/io/Writer.html#write%28char[], int, int%29)(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(String str) Write a string.
void	[write](../../java/io/Writer.html#write%28java.lang.String, int, int%29)(String str, int off, int len) Write a portion of a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Field Detail

lock

protected Object 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.

Constructor Detail

Writer

protected Writer()

Create a new character-stream writer whose critical sections will synchronize on the writer itself.

Writer

protected Writer(Object lock)

Create a new character-stream writer whose critical sections will synchronize on the given object.

Parameters:

lock - Object to synchronize on.

Method Detail

write

public void write(int c) throws IOException

Write 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](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

write

public void write(char[] cbuf) throws IOException

Write an array of characters.

Parameters:

cbuf - Array of characters to be written

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

write

public abstract void write(char[] cbuf, int off, int len) throws IOException

Write a portion of an array of characters.

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

write

public void write(String str) throws IOException

Write a string.

Parameters:

str - String to be written

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

write

public void write(String str, int off, int len) throws IOException

Write a portion of a string.

Parameters:

str - A String

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

append

public Writer append(CharSequence csq) throws IOException

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.

Specified by:

[append](../../java/lang/Appendable.html#append%28java.lang.CharSequence%29) in interface [Appendable](../../java/lang/Appendable.html "interface in java.lang")

Parameters:

csq - The character sequence to append. If csq isnull, then the four characters "null" are appended to this writer.

Returns:

This writer

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Since:

1.5

append

public Writer append(CharSequence csq, int start, int end) throws IOException

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())

Specified by:

[append](../../java/lang/Appendable.html#append%28java.lang.CharSequence, int, int%29) in interface [Appendable](../../java/lang/Appendable.html "interface in java.lang")

Parameters:

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 subsequence

end - The index of the character following the last character in the subsequence

Returns:

This writer

Throws:

[IndexOutOfBoundsException](../../java/lang/IndexOutOfBoundsException.html "class in java.lang") - If start or end are negative, start is greater than end, or end is greater thancsq.length()

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Since:

1.5

append

public Writer append(char c) throws IOException

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)

Specified by:

[append](../../java/lang/Appendable.html#append%28char%29) in interface [Appendable](../../java/lang/Appendable.html "interface in java.lang")

Parameters:

c - The 16-bit character to append

Returns:

This writer

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Since:

1.5

flush

public abstract void flush() throws IOException

Flush 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.

Specified by:

[flush](../../java/io/Flushable.html#flush%28%29) in interface [Flushable](../../java/io/Flushable.html "interface in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

close

public abstract void close() throws IOException

Close the stream, flushing it first. Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously-closed stream, however, has no effect.

Specified by:

[close](../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../java/io/Closeable.html "interface in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.