Top Description Constructors Methods
com.fasterxml.jackson.core.io

public abstract Class OutputDecorator

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@SuppressWarnings:serial
Imports
java.io.*
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.

Constructor Summary

AccessConstructor and Description
public
OutputDecorator()

Method Summary

Modifier and TypeMethod and Description
public abstract OutputStream

Returns:

OutputStream to use; either passed in argument, or something that calls it
decorate(IOContext
IO context in use (provides access to declared encoding)
ctxt, OutputStream
Original output destination
out)

Method called by com.fasterxml.jackson.core.JsonFactory instance when creating generator for given OutputStream, when this decorator has been registered.

public abstract Writer

Returns:

Writer to use; either passed in argument, or something that calls it
decorate(IOContext
IO context in use (provides access to declared encoding)
ctxt, Writer
Original output writer
w)

Method called by com.fasterxml.jackson.core.JsonFactory instance when creating generator for given Writer, when this decorator has been registered.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

OutputDecoratorback to summary
public OutputDecorator()

Method Detail

decorateback to summary
public abstract OutputStream decorate(IOContext ctxt, OutputStream out) throws IOException

Method called by com.fasterxml.jackson.core.JsonFactory instance when creating generator for given OutputStream, when this decorator has been registered.

Parameters
ctxt:IOContext

IO context in use (provides access to declared encoding)

out:OutputStream

Original output destination

Returns:OutputStream

OutputStream to use; either passed in argument, or something that calls it

Exceptions
IOException:
if construction of decorated OutputStream fails
decorateback to summary
public abstract Writer decorate(IOContext ctxt, Writer w) throws IOException

Method called by com.fasterxml.jackson.core.JsonFactory instance when creating generator for given Writer, when this decorator has been registered.

Parameters
ctxt:IOContext

IO context in use (provides access to declared encoding)

w:Writer

Original output writer

Returns:Writer

Writer to use; either passed in argument, or something that calls it

Exceptions
IOException:
if construction of decorated Writer fails