net.java.truecommons.io

Class DecoratingOutputStream

java.lang.Object

java.io.OutputStream

net.java.truecommons.io.DecoratingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

DisconnectingOutputStream, LittleEndianOutputStream, LockOutputStream

public abstract class DecoratingOutputStream
extends OutputStream

An abstract decorator for an output stream. This class is a clean room alternative to FilterOutputStream.

Author:

Christian Schlichtherle

See Also:

DecoratingInputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputStream	out The nullable decorated output stream.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DecoratingOutputStream()
protected	DecoratingOutputStream(OutputStream out)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
String	toString() Returns a string representation of this object for debugging and logging purposes.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Field Detail

out

@Nullable
 @WillCloseWhenClosed
protected OutputStream out

The nullable decorated output stream.

Constructor Detail

DecoratingOutputStream

protected DecoratingOutputStream()

DecoratingOutputStream

protected DecoratingOutputStream(@WillCloseWhenClosed
                                 OutputStream out)

Method Detail

close

@DischargesObligation
public void close()
                                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

toString

public String toString()

Returns a string representation of this object for debugging and logging purposes.

Overrides:

toString in class Object

write

public final void write(byte[] b)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException