Module com.aoapps.lang

Package com.aoapps.lang.io

Class AppendableWriter

java.lang.Object

java.io.Writer

com.aoapps.lang.io.AppendableWriter

All Implemented Interfaces:

NoClose, Closeable, Flushable, Appendable, AutoCloseable

public class AppendableWriter
extends Writer
implements NoClose

Writer that writes to an underlying Appendable. This is not necessarily the absolute fastest way to get things done (at least when a char[] has to be wrapped in a Segment), but can help bridge the gap between APIs based on Writer and Appendable.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AppendableWriter(Appendable out)

Method Summary

Modifier and Type	Method	Description
AppendableWriter	append(char c)
AppendableWriter	append(CharSequence csq)
AppendableWriter	append(CharSequence csq, int start, int end)
void	close()	Calls to close are ignored when NoClose.isNoClose(), otherwise some action might be taken which means close calls to this object may not be skipped or assumed to be ignored.
void	flush()
Appendable	getOut()	Gets the wrapped appendable.
boolean	isNoClose()	Determines if calls to NoClose.close() will be ignored.
static Writer	wrap(Appendable out)	Wraps the given Appendable if it is not already a Writer.
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

AppendableWriter

public AppendableWriter(Appendable out)

Method Detail

wrap

public static Writer wrap(Appendable out)

Wraps the given Appendable if it is not already a Writer.

Returns:

The given out, if it is already a Writer, otherwise an AppendableWriter wrapping out.

getOut

public Appendable getOut()

Gets the wrapped appendable.

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Overrides:

write in class Writer

Throws:

IOException

append

public AppendableWriter append(CharSequence csq)
                        throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public AppendableWriter append(char c)
                        throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

isNoClose

public boolean isNoClose()

Description copied from interface: NoClose

Determines if calls to NoClose.close() will be ignored. This value must not change over time; it may be queried once, repeatedly, or never.

Specified by:

isNoClose in interface NoClose

close

public void close()
           throws IOException

Description copied from interface: NoClose

Calls to close are ignored when NoClose.isNoClose(), otherwise some action might be taken which means close calls to this object may not be skipped or assumed to be ignored.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface NoClose

Specified by:

close in class Writer

Throws:

IOException