com.github.robtimus.obfuscation.support

Class ObfuscatingWriter

java.lang.Object

java.io.Writer

com.github.robtimus.obfuscation.support.ObfuscatingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

CachingObfuscatingWriter

public abstract class ObfuscatingWriter
extends Writer

Abstract class for writing obfuscated text to character streams.

Author:

Rob Spoor

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
ObfuscatingWriter()

Method Summary

Modifier and Type	Method and Description
protected void	checkClosed() Checks whether or not this stream is already closed.
void	close() Closes the stream.
protected boolean	closed() Returns whether or not this stream is already closed.
void	flush() Flushes the stream.
protected void	onClose() Closes the stream, cleaning up any resources.

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ObfuscatingWriter

public ObfuscatingWriter()

Method Detail

checkClosed

protected final void checkClosed()
                          throws IOException

Checks whether or not this stream is already closed. This method should be called from all methods that write or append text.

Throws:

IOException - If this stream is already closed.

flush

public void flush()
           throws IOException

Flushes the stream. This implementation only calls checkClosed(). Sub classes can add additional behaviour if needed.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException - If an I/O error occurs.

close

public final void close()
                 throws IOException

Closes the stream. This method will make sure that actual closing will only be performed once. After calling this method, checkClosed() will throw an IOException.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException - If an I/O error occurs.

closed

protected final boolean closed()

Returns whether or not this stream is already closed.

Returns:

true if this stream is already closed, or false otherwise.

onClose

protected void onClose()
                throws IOException

Closes the stream, cleaning up any resources. This default implementation does nothing.

Throws:

IOException - If an I/O error occurs.