Jackson 2.18.2 · com.fasterxml.jackson.core.io.InputDecorator

Modifier and Type	Field and Description
private static final long	serialVersionUID

Access	Constructor and Description
public	InputDecorator()

Method Summary

Modifier and Type	Method and Description
public abstract InputStream	Returns: InputStream to use; either 'in' as is, or decorator version that typically delogates to 'in' decorate(IOContext 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. ctxt, InputStream Original input source in) Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser given an `InputStream`, when this decorator has been registered.
public abstract InputStream	Returns: Either `InputStream` to use as input source; or null to indicate that contents are to be processed as-is by caller decorate(IOContext 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. ctxt, byte[] Input buffer that contains contents to parse src, int Offset of the first available byte in the input buffer offset, int Number of bytes available in the input buffer length) Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser on given "raw" byte source.
public DataInput	Returns: InputStream to use; either 'input' as is, or decorator version that typically delogates to 'input' decorate(IOContext 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. ctxt, DataInput Original input source input) Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser given an `DataInput`, when this decorator has been registered.
public abstract Reader	Returns: Reader to use; either passed in argument, or something that calls it (for example, a `FilterReader`) decorate(IOContext 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. ctxt, Reader Original reader r) Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser given an `Reader`, when this decorator has been registered.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

serialVersionUID	back to summary
private static final long serialVersionUID

InputDecorator	back to summary
public InputDecorator()

Method Detail

decorate back to summary

decorate	back to summary
public abstract InputStream decorate(IOContext ctxt, InputStream in) throws IOException Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser given an `InputStream`, when this decorator has been registered. Parameters ctxt:IOContext 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:InputStream Original input source Returns:InputStream InputStream to use; either 'in' as is, or decorator version that typically delogates to 'in' Exceptions IOException: if construction of `InputStream` fails

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

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

Parameters

ctxt:IOContext: 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:InputStream: Original input source

Returns:InputStream

InputStream to use; either 'in' as is, or decorator version that typically delogates to 'in'

Exceptions

IOException:: if construction of InputStream fails

decorate back to summary

decorate	back to summary
public abstract InputStream decorate(IOContext ctxt, byte[] src, int offset, int length) throws IOException Method called by `com.fasterxml.jackson.core.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. Parameters ctxt:IOContext 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:byte[] Input buffer that contains contents to parse offset:int Offset of the first available byte in the input buffer length:int Number of bytes available in the input buffer Returns:InputStream Either `InputStream` to use as input source; or null to indicate that contents are to be processed as-is by caller Exceptions IOException: if construction of `InputStream` fails

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

Method called by com.fasterxml.jackson.core.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.

Parameters

ctxt:IOContext: 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:byte[]: Input buffer that contains contents to parse
offset:int: Offset of the first available byte in the input buffer
length:int: Number of bytes available in the input buffer

Returns:InputStream

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

Exceptions

IOException:: if construction of InputStream fails

decorate back to summary

decorate	back to summary
public DataInput decorate(IOContext ctxt, DataInput input) throws IOException Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser given an `DataInput`, when this decorator has been registered. Default implementation simply throws `UnsupportedOperationException` Parameters ctxt:IOContext 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. input:DataInput Original input source Returns:DataInput InputStream to use; either 'input' as is, or decorator version that typically delogates to 'input' Exceptions IOException: if construction of `DataInput` fails Since 2.8

public DataInput decorate(IOContext ctxt, DataInput input) throws IOException

Method called by com.fasterxml.jackson.core.JsonFactory instance when creating parser given an DataInput, when this decorator has been registered.

Default implementation simply throws UnsupportedOperationException

Parameters

ctxt:IOContext: 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.
input:DataInput: Original input source

Returns:DataInput

InputStream to use; either 'input' as is, or decorator version that typically delogates to 'input'

Exceptions

IOException:: if construction of DataInput fails

Since

2.8

decorate back to summary

decorate	back to summary
public abstract Reader decorate(IOContext ctxt, Reader r) throws IOException Method called by `com.fasterxml.jackson.core.JsonFactory` instance when creating parser given an `Reader`, when this decorator has been registered. Parameters ctxt:IOContext 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. r:Reader Original reader Returns:Reader Reader to use; either passed in argument, or something that calls it (for example, a `FilterReader`) Exceptions IOException: if construction of `Reader` fails

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

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

Parameters

ctxt:IOContext: 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.
r:Reader: Original reader

Returns:Reader

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

Exceptions

IOException:: if construction of Reader fails

public abstract Class InputDecorator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail