org.codehaus.jackson.io
Class OutputDecorator

java.lang.Object
  extended by org.codehaus.jackson.io.OutputDecorator

public abstract class OutputDecorator
extends Object

Handler class that can be used to decorate output destinations. Typical use is to use a filter abstraction (filtered output stream, writer) around original output destination, and apply additional processing during write operations.

Since:
1.8

Constructor Summary
OutputDecorator()
           
 
Method Summary
abstract  OutputStream decorate(IOContext ctxt, OutputStream out)
          Method called by JsonFactory instance when creating generator for given OutputStream, when this decorator has been registered.
abstract  Writer decorate(IOContext ctxt, Writer w)
          Method called by JsonFactory instance when creating generator for given Writer, when this decorator has been registered.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputDecorator

public OutputDecorator()
Method Detail

decorate

public abstract OutputStream decorate(IOContext ctxt,
                                      OutputStream out)
                               throws IOException
Method called by JsonFactory instance when creating generator for given OutputStream, when this decorator has been registered.

Parameters:
ctxt - IO context in use (provides access to declared encoding)
out - Original output destination
Returns:
OutputStream to use; either passed in argument, or something that calls it
Throws:
IOException

decorate

public abstract Writer decorate(IOContext ctxt,
                                Writer w)
                         throws IOException
Method called by JsonFactory instance when creating generator for given Writer, when this decorator has been registered.

Parameters:
ctxt - IO context in use (provides access to declared encoding)
w - Original output writer
Returns:
Writer to use; either passed in argument, or something that calls it
Throws:
IOException