jsimple.io

Class Writer

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.Writer

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

StringWriter, Utf8OutputStreamWriter

public abstract class Writer
extends AutoCloseable

This class was based on, and modified from, the Apache Harmony java.io.Writer class. Unlike the standard Java Writer class, this doesn't do locking and doesn't throw any checked exceptions.

The base class for all writers. A writer is a means of writing data to a target in a character-wise manner. Most output streams expect the flush() method to be called before closing the stream, to ensure all data is actually written out.

This abstract class does not provide a fully working implementation, so it needs to be subclassed, and at least the write(char[], int, int), close() and flush() methods needs to be overridden. Overriding some of the non-abstract methods is also often advised, since it might result in higher efficiency.

See Also:

Reader

Constructor Summary

Constructors

Constructor and Description
Writer()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this writer.
abstract void	flush() Flushes this writer.
java.lang.String	getLineSeparator() Get the line separator being used for this writer.
void	setLineSeparator(java.lang.String lineSeparator) Set the line separator for this writer.
void	write(char[] buf) Writes the entire character buffer buf to the target.
abstract void	write(char[] buf, int offset, int count) Writes count characters starting at offset in buf to the target.
void	write(int oneChar) Writes one character to the target.
void	write(java.lang.String str) Writes the characters from the specified string to the target.
void	write(java.lang.String str, int offset, int count) Writes count characters from str starting at offset to the target.
void	writeln() Write the line separator.
void	writeln(java.lang.String str) Writes the characters from the specified string followed by a line separator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Writer

public Writer()

Method Detail

close

public abstract void close()

Closes this writer. Implementations of this method should free any resources associated with the writer.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class AutoCloseable

Throws:

IOException - if an error occurs while closing this writer.

flush

public abstract void flush()

Flushes this writer. Implementations of this method should ensure that all buffered characters are written to the target.

Throws:

IOException - if an error occurs while flushing this writer.

write

public void write(char[] buf)

Writes the entire character buffer buf to the target.

Parameters:

buf - the non-null array containing characters to write

Throws:

IOException - if this writer is closed or another I/O error occurs.

write

public abstract void write(char[] buf,
                           int offset,
                           int count)

Writes count characters starting at offset in buf to the target.

Parameters:

buf - the non-null character array to write.

offset - the index of the first character in buf to write.

count - the maximum number of characters to write.

Throws:

IOException - if this writer is closed or another I/O error occurs.

write

public void write(int oneChar)

Writes one character to the target. Only the two least significant bytes of the integer oneChar are written.

Parameters:

oneChar - the character to write to the target.

Throws:

IOException - if this writer is closed or another I/O error occurs.

write

public void write(java.lang.String str)

Writes the characters from the specified string to the target.

Parameters:

str - the non-null string containing the characters to write

Throws:

IOException - if this writer is closed or another I/O error occurs

write

public void write(java.lang.String str,
                  int offset,
                  int count)

Writes count characters from str starting at offset to the target.

Parameters:

str - the non-null string containing the characters to write

offset - the index of the first character in str to write

count - the number of characters from str to write.

Throws:

IOException - if this writer is closed or another I/O error occurs

getLineSeparator

public java.lang.String getLineSeparator()

Get the line separator being used for this writer. By default, it's the platform default line separator.

Returns:

current line separator

setLineSeparator

public void setLineSeparator(java.lang.String lineSeparator)

Set the line separator for this writer.

Parameters:

lineSeparator - line separator

writeln

public final void writeln()

Write the line separator.

writeln

public final void writeln(java.lang.String str)

Writes the characters from the specified string followed by a line separator.

Parameters:

str - string to write