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:

java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class OutputStreamPrinter
extends Printer

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.

Version:

$Revision$

Author:

Julien Viet

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

OutputStreamPrinter(TextEncoder encoder, java.io.OutputStream out)
Builds an instance with the failureFlow being IOFailureFlow.RETHROW and a the ignoreOnFailure property set to false.

OutputStreamPrinter(TextEncoder encoder, java.io.OutputStream out, IOFailureFlow failureFlow, boolean ignoreOnFailure)
Builds a new instance.

Method Summary

void	close()
void	flush()
IOFailureFlow	getFailureFlow() Returns the failure flow.
boolean	getIgnoreOnFailure() Returns the ignore on failure property.
boolean	isFailed()
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)

Methods inherited from class org.exoplatform.commons.utils.Printer

print, println, println

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,
                           java.io.OutputStream out)
                    throws java.lang.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:

java.lang.IllegalArgumentException - if any argument is null

OutputStreamPrinter

public OutputStreamPrinter(TextEncoder encoder,
                           java.io.OutputStream out,
                           IOFailureFlow failureFlow,
                           boolean ignoreOnFailure)
                    throws java.lang.IllegalArgumentException

Builds a new instance.

Parameters:

encoder - the encoder

out - the output

failureFlow - the control flow failureFlow

ignoreOnFailure - the behavior on failure

Throws:

java.lang.IllegalArgumentException - if any argument is null

Method Detail

getFailureFlow

public IOFailureFlow getFailureFlow()

Returns the failure flow.

Returns:

the failure flow

getIgnoreOnFailure

public boolean getIgnoreOnFailure()

Returns the ignore on failure property.

Returns:

the ignore on failure property

isFailed

public boolean isFailed()

write

public void write(int c)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char[] cbuf)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

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

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException