Modifier and Type	Class and Description
protected static class	DataFormatReaders.AccessorForReader We need sub-class here as well, to be able to access efficiently.
public static class	DataFormatReaders.Match Result class, similar to `DataFormatMatcher`

Modifier and Type	Field and Description
protected final int	_maxInputLookahead Maximum number of leading bytes of the input that we can read to determine data format.
protected final MatchStrength	_minimalMatch Strength of minimal match we accept as the answer, unless better matches are found.
protected final MatchStrength	_optimalMatch Strength of match we consider to be good enough to be used without checking any other formats.
protected final ObjectReader[]	_readers Ordered list of readers which both represent data formats to detect (in precedence order, starting with highest) and contain factories used for actual detection.
public static final int	DEFAULT_MAX_INPUT_LOOKAHEAD By default we will look ahead at most 64 bytes; in most cases, much less (4 bytes or so) is needed, but we will allow bit more leniency to support data formats that need more complex heuristics.

Access	Constructor and Description
public	DataFormatReaders(ObjectReader... detectors)
public	DataFormatReaders(Collection<ObjectReader> detectors)
private	DataFormatReaders(ObjectReader[] detectors, MatchStrength optMatch, MatchStrength minMatch, int maxInputLookahead)

Method Summary

Modifier and Type	Method and Description
private DataFormatReaders.Match	_findFormat(DataFormatReaders.AccessorForReader acc)
public DataFormatReaders.Match	Returns: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. findFormat(InputStream in) Method to call to find format that content (accessible via given `InputStream`) given has, as per configuration of this detector instance.
public DataFormatReaders.Match	Returns: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. findFormat(byte[] fullInputData) Method to call to find format that given content (full document) has, as per configuration of this detector instance.
public DataFormatReaders.Match	Returns: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. findFormat(byte[] fullInputData, int offset, int len) Method to call to find format that given content (full document) has, as per configuration of this detector instance.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public DataFormatReaders	with(ObjectReader[] readers)
public DataFormatReaders	with(DeserializationConfig config)
public DataFormatReaders	withMaxInputLookahead(int lookaheadBytes)
public DataFormatReaders	withMinimalMatch(MatchStrength minMatch)
public DataFormatReaders	withOptimalMatch(MatchStrength optMatch)
public DataFormatReaders	withType(JavaType type)

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

Field Detail

_maxInputLookahead back to summary

_maxInputLookahead	back to summary
protected final int _maxInputLookahead Maximum number of leading bytes of the input that we can read to determine data format. Default value is `DEFAULT_MAX_INPUT_LOOKAHEAD`.

protected final int _maxInputLookahead

Maximum number of leading bytes of the input that we can read to determine data format.

Default value is DEFAULT_MAX_INPUT_LOOKAHEAD.

_minimalMatch	back to summary
protected final MatchStrength _minimalMatch Strength of minimal match we accept as the answer, unless better matches are found. Default value is `MatchStrength#WEAK_MATCH`,

_optimalMatch	back to summary
protected final MatchStrength _optimalMatch Strength of match we consider to be good enough to be used without checking any other formats. Default value is `MatchStrength#SOLID_MATCH`,

_readers	back to summary
protected final ObjectReader[] _readers Ordered list of readers which both represent data formats to detect (in precedence order, starting with highest) and contain factories used for actual detection.

DEFAULT_MAX_INPUT_LOOKAHEAD	back to summary
public static final int DEFAULT_MAX_INPUT_LOOKAHEAD By default we will look ahead at most 64 bytes; in most cases, much less (4 bytes or so) is needed, but we will allow bit more leniency to support data formats that need more complex heuristics.

Constructor Detail

DataFormatReaders	back to summary
public DataFormatReaders(ObjectReader... detectors)

DataFormatReaders	back to summary
public DataFormatReaders(Collection<ObjectReader> detectors)

DataFormatReaders	back to summary
private DataFormatReaders(ObjectReader[] detectors, MatchStrength optMatch, MatchStrength minMatch, int maxInputLookahead)

Method Detail

_findFormat	back to summary
private DataFormatReaders.Match _findFormat(DataFormatReaders.AccessorForReader acc) throws IOException

findFormat back to summary

findFormat	back to summary
public DataFormatReaders.Match findFormat(InputStream in) throws IOException Method to call to find format that content (accessible via given `InputStream`) given has, as per configuration of this detector instance. Returns:DataFormatReaders.Match Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found.

public DataFormatReaders.Match findFormat(InputStream in) throws IOException

Method to call to find format that content (accessible via given InputStream) given has, as per configuration of this detector instance.

Returns:DataFormatReaders.Match: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found.

findFormat	back to summary
public DataFormatReaders.Match findFormat(byte[] fullInputData) throws IOException Method to call to find format that given content (full document) has, as per configuration of this detector instance. Returns:DataFormatReaders.Match Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found.

findFormat

back to summary

public DataFormatReaders.Match findFormat(byte[] fullInputData) throws IOException

Method to call to find format that given content (full document) has, as per configuration of this detector instance.

Returns:DataFormatReaders.Match: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found.

findFormat	back to summary
public DataFormatReaders.Match findFormat(byte[] fullInputData, int offset, int len) throws IOException Method to call to find format that given content (full document) has, as per configuration of this detector instance. Returns:DataFormatReaders.Match Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. Since 2.1

findFormat

back to summary

public DataFormatReaders.Match findFormat(byte[] fullInputData, int offset, int len) throws IOException

Method to call to find format that given content (full document) has, as per configuration of this detector instance.

Returns:DataFormatReaders.Match: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found.
Since: 2.1

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

with	back to summary
public DataFormatReaders with(ObjectReader[] readers)

with	back to summary
public DataFormatReaders with(DeserializationConfig config)

withMaxInputLookahead	back to summary
public DataFormatReaders withMaxInputLookahead(int lookaheadBytes)

withMinimalMatch	back to summary
public DataFormatReaders withMinimalMatch(MatchStrength minMatch)

withOptimalMatch	back to summary
public DataFormatReaders withOptimalMatch(MatchStrength optMatch)

withType	back to summary
public DataFormatReaders withType(JavaType type)

com.fasterxml.jackson.databind.deser back to summary

protected Class DataFormatReaders.AccessorForReader

Class Inheritance

extends Std

java.lang.Object
com.fasterxml.jackson.core.format.InputAccessor.Std
com.fasterxml.jackson.databind.deser.DataFormatReaders.AccessorForReader

We need sub-class here as well, to be able to access efficiently.

Field Summary

Inherited from com.fasterxml.jackson.core.format.InputAccessor.Std:: _buffer _bufferedEnd _bufferedStart _in _ptr

Constructor Summary

Access	Constructor and Description
public	AccessorForReader(InputStream in, byte[] buffer)
public	AccessorForReader(byte[] inputDocument)
public	AccessorForReader(byte[] inputDocument, int start, int len)

Method Summary

Modifier and Type	Method and Description
public DataFormatReaders.Match	createMatcher(ObjectReader match, MatchStrength matchStrength)

Inherited from com.fasterxml.jackson.core.format.InputAccessor.Std:: createMatcher hasMoreBytes nextByte reset

Constructor Detail

AccessorForReader	back to summary
public AccessorForReader(InputStream in, byte[] buffer)

AccessorForReader	back to summary
public AccessorForReader(byte[] inputDocument)

AccessorForReader	back to summary
public AccessorForReader(byte[] inputDocument, int start, int len)

Method Detail

createMatcher	back to summary
public DataFormatReaders.Match createMatcher(ObjectReader match, MatchStrength matchStrength)

com.fasterxml.jackson.databind.deser back to summary

public Class DataFormatReaders.Match

Class Inheritance

extends Object

java.lang.Object
com.fasterxml.jackson.databind.deser.DataFormatReaders.Match

Result class, similar to DataFormatMatcher

Field Summary

Modifier and Type	Field and Description
protected final byte[]	_bufferedData Content read during format matching process
protected final int	_bufferedLength Number of bytes available in buffer.
protected final int	_bufferedStart Pointer to the first byte in buffer available for reading
protected final ObjectReader	_match Factory that produced sufficient match (if any)
protected final MatchStrength	_matchStrength Strength of match with `_match`
protected final InputStream	_originalStream

Constructor Summary

Access	Constructor and Description
protected	Match(InputStream in, byte[] buffered, int bufferedStart, int bufferedLength, ObjectReader match, MatchStrength strength)

Method Summary

Modifier and Type	Method and Description
public JsonParser	createParserWithMatch() Convenience method for trying to construct a `JsonParser` for parsing content which is assumed to be in detected data format.
public InputStream	getDataStream() Method to use for accessing input for which format detection has been done.
public String	getMatchedFormatName() Accessor for getting brief textual name of matched format if any (null if none).
public MatchStrength	getMatchStrength() Method for accessing strength of the match, if any; if no match, will return `MatchStrength#INCONCLUSIVE`.
public ObjectReader	getReader() Accessor for `JsonFactory` that represents format that data matched.
public boolean	hasMatch() Accessor to use to see if any formats matched well enough with the input data.

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

Field Detail

_bufferedData	back to summary
protected final byte[] _bufferedData Content read during format matching process

_bufferedLength	back to summary
protected final int _bufferedLength Number of bytes available in buffer.

_bufferedStart	back to summary
protected final int _bufferedStart Pointer to the first byte in buffer available for reading

_match	back to summary
protected final ObjectReader _match Factory that produced sufficient match (if any)

_matchStrength	back to summary
protected final MatchStrength _matchStrength Strength of match with `_match`

_originalStream	back to summary
protected final InputStream _originalStream

Constructor Detail

Match	back to summary
protected Match(InputStream in, byte[] buffered, int bufferedStart, int bufferedLength, ObjectReader match, MatchStrength strength)

Method Detail

createParserWithMatch	back to summary
public JsonParser createParserWithMatch() throws IOException Convenience method for trying to construct a `JsonParser` for parsing content which is assumed to be in detected data format. If no match was found, returns null.

getDataStream	back to summary
public InputStream getDataStream() Method to use for accessing input for which format detection has been done. This must be used instead of using stream passed to detector unless given stream itself can do buffering. Stream will return all content that was read during matching process, as well as remaining contents of the underlying stream.

getMatchedFormatName	back to summary
public String getMatchedFormatName() Accessor for getting brief textual name of matched format if any (null if none). Equivalent to: return hasMatch() ? getMatch().getFormatName() : null;

getMatchedFormatName

back to summary

public String getMatchedFormatName()

Accessor for getting brief textual name of matched format if any (null if none). Equivalent to:

   return hasMatch() ? getMatch().getFormatName() : null;

getMatchStrength	back to summary
public MatchStrength getMatchStrength() Method for accessing strength of the match, if any; if no match, will return `MatchStrength#INCONCLUSIVE`.

getReader	back to summary
public ObjectReader getReader() Accessor for `JsonFactory` that represents format that data matched.

hasMatch	back to summary
public boolean hasMatch() Accessor to use to see if any formats matched well enough with the input data.

public Class DataFormatReaders

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class DataFormatReaders.AccessorForReader

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class DataFormatReaders.Match

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail