|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.io.Writer
public abstract class Writer
This abstract class forms the base of the hierarchy of classes that write output as a stream of chars. It provides a common set of methods for writing chars to stream. Subclasses implement and/or extend these methods to write chars in a particular manner or to a particular destination such as a file on disk or network connection.
| Field Summary | |
|---|---|
protected Object |
lock
This is the object used to synchronize criticial code sections for thread safety. |
| Constructor Summary | |
|---|---|
protected |
Writer()
This is the default no-argument constructor for this class. |
protected |
Writer(Object lock)
This method initializes a Writer that will synchronize
on the specified Object. |
| Method Summary | |
|---|---|
Writer |
append(char c)
Appends the Unicode character, c, to this Appendable
object. |
Writer |
append(CharSequence cs)
Appends the specified sequence of Unicode characters to this Appendable object. |
Writer |
append(CharSequence cs,
int start,
int end)
Appends the specified subsequence of Unicode characters to this Appendable object, starting and ending at the specified
positions within the sequence. |
abstract void |
close()
This method closes the stream. |
abstract void |
flush()
This method forces any data that may have been buffered to be written to the underlying output device. |
void |
write(char[] buf)
This method all the writes char from the passed array to the output stream. |
abstract void |
write(char[] buf,
int offset,
int len)
This method writes len char from the specified array
buf starting at index offset into the array. |
void |
write(int b)
This method writes a single char to the output stream. |
void |
write(String str)
This method writes all the characters in a String to the
output. |
void |
write(String str,
int offset,
int len)
This method writes len chars from the String
starting at position offset. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Object lock
this
| Constructor Detail |
|---|
protected Writer()
protected Writer(Object lock)
Writer that will synchronize
on the specified Object.
lock - The Object to use for synchronizing critical
sections. Must not be null.| Method Detail |
|---|
public abstract void flush()
throws IOException
flush in interface FlushableIOException - If an error occurs
public abstract void close()
throws IOException
This method in this class does nothing.
close in interface CloseableIOException - If an error occurs
public void write(int b)
throws IOException
b - The char to be written to the output stream, passed as an int
IOException - If an error occurs
public void write(char[] buf)
throws IOException
write(buf, 0, buf.length) which
is exactly how it is implemented in this class.
buf - The array of char to write
IOException - If an error occurs
public abstract void write(char[] buf,
int offset,
int len)
throws IOException
len char from the specified array
buf starting at index offset into the array.
Subclasses must provide an implementation of this abstract method.
buf - The array of char to write fromoffset - The index into the array to start writing fromlen - The number of char to write
IOException - If an error occurs
public void write(String str)
throws IOException
String to the
output.
str - The String whose chars are to be written.
IOException - If an error occurs
public void write(String str,
int offset,
int len)
throws IOException
len chars from the String
starting at position offset.
str - The String that is to be writtenoffset - The character offset into the String to start
writing fromlen - The number of chars to write
IOException - If an error occurs
public Writer append(char c)
throws IOException
AppendableAppendable
object.
append in interface Appendablec - the character to append.
IOException - if an I/O error occurs.
public Writer append(CharSequence cs)
throws IOException
AppendableAppendable object. The entire sequence may not
be appended, if constrained by the underlying implementation.
For example, a buffer may reach its size limit before the entire
sequence is appended.
append in interface Appendablecs - the character sequence to append. If seq is null,
then the string "null" (the string representation of null)
is appended.
IOException - if an I/O error occurs.
public Writer append(CharSequence cs,
int start,
int end)
throws IOException
AppendableAppendable object, starting and ending at the specified
positions within the sequence. The entire sequence may not
be appended, if constrained by the underlying implementation.
For example, a buffer may reach its size limit before the entire
sequence is appended. The behaviour of this method matches the
behaviour of append(seq.subSequence(start,end)) when
the sequence is not null.
append in interface Appendablecs - the character sequence to append. If seq is null,
then the string "null" (the string representation of null)
is appended.start - the index of the first Unicode character to use from
the sequence.end - the index of the last Unicode character to use from the
sequence.
IOException - if an I/O error occurs.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||