Writer (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- java.io.Writer
All Implemented Interfaces:
Closeable, Flushable, Appendable, AutoCloseable
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
See Also:
Writer, BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, FileWriter, PipedWriter, PrintWriter, StringWriter, Reader

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	lock The object used to synchronize operations on this stream.

Constructor Summary

Constructors

Modifier	Constructor and Description
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

Methods

Modifier and Type	Method and Description
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(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
abstract void	close() Closes the stream, flushing it first.
abstract void	flush() Flushes the stream.
void	write(char[] cbuf) Writes an array of characters.
abstract void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(int c) Writes a single character.
void	write(String str) Writes a string.
void	write(String str, int off, int len) Writes a portion of a string.

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

Field Detail

 * #### lock  
 protected [Object](../../java/lang/Object.html "class in java.lang") 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()  
Creates a new character-stream writer whose critical sections will synchronize on the writer itself.  
* #### Writer  
protected Writer([Object](../../java/lang/Object.html "class in java.lang") lock)  
Creates 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](../../java/io/IOException.html "class in java.io")  
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](../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
* #### write  
public void write(char[] cbuf)  
           throws [IOException](../../java/io/IOException.html "class in java.io")  
Writes 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](../../java/io/IOException.html "class in java.io")  
Writes 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](../../java/lang/String.html "class in java.lang") str)  
           throws [IOException](../../java/io/IOException.html "class in java.io")  
Writes 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](../../java/lang/String.html "class in java.lang") str,  
         int off,  
         int len)  
           throws [IOException](../../java/io/IOException.html "class in java.io")  
Writes a portion of a string.  
Parameters:  
`str` \- A String  
`off` \- Offset from which to start writing characters  
`len` \- Number of characters to write  
Throws:  
`[IndexOutOfBoundsException](../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- If off is negative, or len is negative, or off+len is negative or greater than the length of the given string  
`[IOException](../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs  
* #### append  
public [Writer](../../java/io/Writer.html "class in java.io") append([CharSequence](../../java/lang/CharSequence.html "interface in java.lang") csq)  
              throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/Writer.html "class in java.io") append([CharSequence](../../java/lang/CharSequence.html "interface in java.lang") csq,  
            int start,  
            int end)  
              throws [IOException](../../java/io/IOException.html "class in java.io")  
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,%20int,%20int%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](../../java/io/Writer.html "class in java.io") append(char c)  
              throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/IOException.html "class in java.io")  
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.  
**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](../../java/io/IOException.html "class in java.io")  
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.  
**Specified by:**  
`[close](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")`  
**Specified by:**  
`[close](../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")`  
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 SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Writer (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail