Module com.aoapps.lang

Package com.aoapps.lang.io

Class WriterFacade

java.lang.Object

java.io.Writer

com.aoapps.lang.io.WriterFacade

All Implemented Interfaces:

NoClose, Closeable, Flushable, Appendable, AutoCloseable

public final class WriterFacade
extends Writer
implements NoClose

Wraps a writer while passing-through all methods of the writer class. This is used to hide the implementation of writer from calling classes.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method	Description
WriterFacade	append(char c)
WriterFacade	append(CharSequence csq)
WriterFacade	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()
static WriterFacade	getInstance(Writer out)	Gets an instance of the WriterFacade that wraps the given Writer.
boolean	isNoClose()	Determines if calls to NoClose.close() will be ignored.
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

Method Details

getInstance

public static WriterFacade getInstance(Writer out)

Gets an instance of the WriterFacade that wraps the given Writer. If the provided writer is already a WriterFacade, returns it without additional wrapping.

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 WriterFacade append(CharSequence csq)
                    throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public WriterFacade 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