org.exoplatform.commons.utils

Class OutputStreamPrinter

java.lang.Object

java.io.Writer

org.exoplatform.commons.utils.Printer

org.exoplatform.commons.utils.OutputStreamPrinter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, BinaryOutput

public class OutputStreamPrinter
extends Printer
implements BinaryOutput

An extension of Printer that encodes the text with a provided encoder and sends the resulting bytes on an OutputStream. The instance can be configured to have different behavior on failure of the output stream.

The ignoreOnFailure property will stop to make further invocations to the output stream if an exception is thrown by the output stream except for the close() method.

The failureFlow property modifies the control flow of the method invocation when the output stream throws an IOException.

• The IOFailureFlow.IGNORE value ignores the exception.
• The IOFailureFlow.RETHROW value rethrows the exception.
• The IOFailureFlow.THROW_UNDECLARED value throws instead a UndeclaredIOException exception wrapping the original exception.

The class provides direct write access to the underlying output stream when the client of the stream can provides bytes directly.

Version:

$Revision$

Author:

Julien Viet

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
OutputStreamPrinter(TextEncoder encoder, OutputStream out) Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.
OutputStreamPrinter(TextEncoder encoder, OutputStream out, boolean flushOnClose) Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.
OutputStreamPrinter(TextEncoder encoder, OutputStream out, boolean flushOnClose, int bufferSize) Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.
OutputStreamPrinter(TextEncoder encoder, OutputStream out, boolean flushOnClose, int bufferSize, boolean growing) Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.
OutputStreamPrinter(TextEncoder encoder, OutputStream out, IOFailureFlow failureFlow, boolean ignoreOnFailure, boolean flushOnClose, int bufferSize) Builds a new instance with the specified parameters and the delegate output.
OutputStreamPrinter(TextEncoder encoder, OutputStream out, IOFailureFlow failureFlow, boolean ignoreOnFailure, boolean flushOnClose, int bufferSize, boolean growing)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	flushOutputStream() Flush the output stream.
Charset	getCharset()
IOFailureFlow	getFailureFlow() Returns the failure flow.
boolean	getIgnoreOnFailure() Returns the ignore on failure property.
boolean	isFailed()
void	write(byte b)
void	write(byte[] bytes)
void	write(byte[] bytes, int off, int len)
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

append, append, append

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           OutputStream out,
                           boolean flushOnClose)
                    throws IllegalArgumentException

Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.

Parameters:

encoder - the encoder

out - the output

flushOnClose - flush when stream is closed

Throws:

IllegalArgumentException - if any argument is null

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           OutputStream out,
                           boolean flushOnClose,
                           int bufferSize)
                    throws IllegalArgumentException

Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.

Parameters:

encoder - the encoder

out - the output

flushOnClose - flush when stream is closed

bufferSize - the size of the buffer

Throws:

IllegalArgumentException - if any argument is null

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           OutputStream out,
                           boolean flushOnClose,
                           int bufferSize,
                           boolean growing)
                    throws IllegalArgumentException

Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.

Parameters:

encoder - the encoder

out - the output

flushOnClose - flush when stream is closed

bufferSize - the initial size of the buffer

growing - if the buffer should grow in size once full

Throws:

IllegalArgumentException - if any argument is null

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           OutputStream out)
                    throws IllegalArgumentException

Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.

Parameters:

encoder - the encoder

out - the output

Throws:

IllegalArgumentException - if any argument is null

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           OutputStream out,
                           IOFailureFlow failureFlow,
                           boolean ignoreOnFailure,
                           boolean flushOnClose,
                           int bufferSize)
                    throws IllegalArgumentException

Builds a new instance with the specified parameters and the delegate output.

Parameters:

encoder - the encoder

out - the output

failureFlow - the control flow failureFlow

ignoreOnFailure - the behavior on failure

flushOnClose - flush when stream is closed

bufferSize - the buffer size

Throws:

IllegalArgumentException - if any argument is null

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           OutputStream out,
                           IOFailureFlow failureFlow,
                           boolean ignoreOnFailure,
                           boolean flushOnClose,
                           int bufferSize,
                           boolean growing)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

getCharset

public final Charset getCharset()

Specified by:

getCharset in interface BinaryOutput

getFailureFlow

public final IOFailureFlow getFailureFlow()

Returns the failure flow.

Returns:

the failure flow

getIgnoreOnFailure

public final boolean getIgnoreOnFailure()

Returns the ignore on failure property.

Returns:

the ignore on failure property

isFailed

public final boolean isFailed()

write

public final void write(byte b)
                 throws IOException

Specified by:

write in interface BinaryOutput

Throws:

IOException

write

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

Specified by:

write in interface BinaryOutput

Throws:

IOException

write

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

Specified by:

write in interface BinaryOutput

Throws:

IOException

write

public final void write(int c)
                 throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public final void write(char[] cbuf)
                 throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public final void write(String str)
                 throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Overrides:

write in class Writer

Throws:

IOException

write

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

Specified by:

write in class Writer

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public final void close()
                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException

flushOutputStream

public void flushOutputStream()
                       throws IOException

Flush the output stream. This allows for the outputstream to be independently flushed regardless of the flushOnClose setting.

Throws:

IOException