org.codehaus.jackson.io

类 InputDecorator

java.lang.Object

org.codehaus.jackson.io.InputDecorator

public abstract class InputDecorator
extends Object

Handler class that can be used to decorate input sources. Typical use is to use a filter abstraction (filtered stream, reader) around original input source, and apply additional processing during read operations.

从以下版本开始:

1.8

构造器概要

构造器

构造器和说明
InputDecorator()

方法概要

方法

限定符和类型	方法和说明
abstract InputStream	decorate(IOContext ctxt, byte[] src, int offset, int length) Method called by JsonFactory instance when creating parser on given "raw" byte source.
abstract InputStream	decorate(IOContext ctxt, InputStream in) Method called by JsonFactory instance when creating parser given an InputStream, when this decorator has been registered.
abstract Reader	decorate(IOContext ctxt, Reader src) Method called by JsonFactory instance when creating parser given an Reader, when this decorator has been registered.

从类继承的方法 java.lang.Object

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

构造器详细资料

InputDecorator

public InputDecorator()

方法详细资料

decorate

public abstract InputStream decorate(IOContext ctxt,
                   InputStream in)
                              throws IOException

Method called by JsonFactory instance when creating parser given an InputStream, when this decorator has been registered.

参数:

ctxt - IO context in use (provides access to declared encoding). NOTE: at this point context may not have all information initialized; specifically auto-detected encoding is only available once parsing starts, which may occur only after this method is called.

in - Original input source

返回:

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

抛出:

IOException

decorate

public abstract InputStream decorate(IOContext ctxt,
                   byte[] src,
                   int offset,
                   int length)
                              throws IOException

Method called by JsonFactory instance when creating parser on given "raw" byte source. Method can either construct a InputStream for reading; or return null to indicate that no wrapping should occur.

参数:

ctxt - IO context in use (provides access to declared encoding) NOTE: at this point context may not have all information initialized; specifically auto-detected encoding is only available once parsing starts, which may occur only after this method is called.

src - Input buffer that contains contents to parse

offset - Offset of the first available byte in the input buffer

length - Number of bytes available in the input buffer

返回:

Either InputStream to use as input source; or null to indicate that contents are to be processed as-is by caller

抛出:

IOException

decorate

public abstract Reader decorate(IOContext ctxt,
              Reader src)
                         throws IOException

Method called by JsonFactory instance when creating parser given an Reader, when this decorator has been registered.

参数:

ctxt - IO context in use (provides access to declared encoding) NOTE: at this point context may not have all information initialized; specifically auto-detected encoding is only available once parsing starts, which may occur only after this method is called.

src - Original input source

返回:

Reader to use; either passed in argument, or something that calls it (for example, a FilterReader)

抛出:

IOException