Package org.apache.sis.io

Class AppendableWriter

java.lang.Object

java.io.Writer

org.apache.sis.io.AppendableWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

final class AppendableWriter
extends Writer

Wraps a Appendable as a Writer.

Since:

0.3

Version:

0.3

Field Summary

Fields

Modifier and Type	Field	Description
private final Appendable	out	The underlying character output stream or buffer.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AppendableWriter(Appendable out)	Creates a new filtered formatter which will send its output to the given stream or buffer.

Method Summary

Modifier and Type	Method	Description
Writer	append(char c)	Forwards the given single character to out.
Writer	append(CharSequence sequence)	Forwards the given character sequence to out.
Writer	append(CharSequence sequence, int start, int end)	Forwards the given character sub-sequence to out.
void	close()	If out implements Closeable, or is a Appender wrapper around a closeable object, delegates to that object.
void	flush()	If out implements Flushable, or is a Appender wrapper around a flushable object, delegates to that object.
private static Object	getLock(Appendable out)	Returns the synchronization lock to use for writing to the given Appendable.
String	toString()	Returns the content of the underlying Appendable as a string if possible, or the localized "Unavailable content" string otherwise.
void	write(char[] cbuf, int offset, int length)	Forwards the given character array to out.
void	write(int c)	Forwards the given single character to out.
void	write(String string)	Forwards the given string to out.
void	write(String string, int start, int length)	Forwards the given sub-string to out.

Methods inherited from class java.io.Writer

write

Methods inherited from class java.lang.Object

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

Field Details

out

private final Appendable out

The underlying character output stream or buffer.

Constructor Details

AppendableWriter

AppendableWriter(Appendable out)

Creates a new filtered formatter which will send its output to the given stream or buffer.

Parameters:

out - the underlying character output stream or buffer.

Method Details

getLock

private static Object getLock(Appendable out)

Returns the synchronization lock to use for writing to the given Appendable. In particular if the final destination is a StringBuffer, we want to lock on that buffer since it is already synchronized on itself (so we get only one lock, not two). If the final destination is another writer, we would use its Writer.lock field if it wasn't protected... As a fallback we use the writer itself, since writers are often synchronized on themselves.

append

public Writer append(char c)
              throws IOException

Forwards the given single character to out.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Forwards the given single character to out.

Overrides:

write in class Writer

Throws:

IOException

append

public Writer append(CharSequence sequence)
              throws IOException

Forwards the given character sequence to out.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

write

public void write(String string)
           throws IOException

Forwards the given string to out.

Overrides:

write in class Writer

Throws:

IOException

append

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

Forwards the given character sub-sequence to out.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

write

public void write(String string,
 int start,
 int length)
           throws IOException

Forwards the given sub-string to out.

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf,
 int offset,
 int length)
           throws IOException

Forwards the given character array to out.

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

If out implements Flushable, or is a Appender wrapper around a flushable object, delegates to that object. Otherwise do nothing.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

If out implements Closeable, or is a Appender wrapper around a closeable object, delegates to that object. Otherwise just flush (if possible).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

toString

public String toString()

Returns the content of the underlying Appendable as a string if possible, or the localized "Unavailable content" string otherwise.

Overrides:

toString in class Object

Returns:

the content of the underlying Appendable, or a localized message for unavailable content.

See Also:

• IO.content(Appendable)