Jackson-core 2.16.0 · com.fasterxml.jackson.core.format.DataFormatDetector

Field Summary

Modifier and Type	Field and Description
protected final JsonFactory[]	_detectors Ordered list of factories which both represent data formats to detect (in precedence order, starting with highest) and are used for actual detection.
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.
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 Summary

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

Method Summary

Modifier and Type	Method and Description
private DataFormatMatcher	_findFormat(InputAccessor.Std acc)
public DataFormatMatcher	Returns: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. findFormat(InputStream InputStream from which to read initial content in) Method to call to find format that content (accessible via given `InputStream`) given has, as per configuration of this detector instance.
public DataFormatMatcher	Returns: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. findFormat(byte[] Full contents to use for format detection fullInputData) Method to call to find format that given content (full document) has, as per configuration of this detector instance.
public DataFormatMatcher	Returns: Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. findFormat(byte[] Full contents to use for format detection fullInputData, int Offset of the first content byte offset, int Length of content 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 DataFormatDetector	Returns: Format detector instance with specified lookahead settings withMaxInputLookahead(int Amount of look-ahead allowed lookaheadBytes) Method that will return a detector instance that allows detectors to read up to specified number of bytes when determining format match strength.
public DataFormatDetector	Returns: Format detector instance with specified minimum match level withMinimalMatch(MatchStrength Minimum match level to use minMatch) Method that will return a detector instance that uses given minimal match level; match that may be returned unless a stronger match is found with other format detectors.
public DataFormatDetector	Returns: Format detector instance with specified optimal match level withOptimalMatch(MatchStrength Optimal match level to use optMatch) Method that will return a detector instance that uses given optimal match level (match that is considered sufficient to return, without trying to find stronger matches with other formats).

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

Field Detail

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

_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`,

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

DataFormatDetector	back to summary
public DataFormatDetector(JsonFactory... detectors)

DataFormatDetector	back to summary
public DataFormatDetector(Collection<JsonFactory> detectors)

DataFormatDetector	back to summary
private DataFormatDetector(JsonFactory[] detectors, MatchStrength optMatch, MatchStrength minMatch, int maxInputLookahead)

Method Detail

_findFormat	back to summary
private DataFormatMatcher _findFormat(InputAccessor.Std acc) throws IOException

findFormat back to summary

findFormat	back to summary
public DataFormatMatcher 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. Parameters in:InputStream InputStream from which to read initial content Returns:DataFormatMatcher Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. Exceptions IOException: for read I/O problems

public DataFormatMatcher 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.

Parameters

in:InputStream: InputStream from which to read initial content

Returns:DataFormatMatcher

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

Exceptions

IOException:: for read I/O problems

findFormat	back to summary
public DataFormatMatcher findFormat(byte[] fullInputData) throws IOException Method to call to find format that given content (full document) has, as per configuration of this detector instance. Parameters fullInputData:byte[] Full contents to use for format detection Returns:DataFormatMatcher Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. Exceptions IOException: for read I/O problems

findFormat

back to summary

public DataFormatMatcher findFormat(byte[] fullInputData) throws IOException

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

Parameters

fullInputData:byte[]: Full contents to use for format detection

Returns:DataFormatMatcher

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

Exceptions

IOException:: for read I/O problems

findFormat	back to summary
public DataFormatMatcher 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. Parameters fullInputData:byte[] Full contents to use for format detection offset:int Offset of the first content byte len:int Length of content Returns:DataFormatMatcher Matcher object which contains result; never null, even in cases where no match (with specified minimal match strength) is found. Exceptions IOException: for read I/O problems Since 2.1

findFormat

back to summary

public DataFormatMatcher 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.

Parameters

fullInputData:byte[]: Full contents to use for format detection
offset:int: Offset of the first content byte
len:int: Length of content

Returns:DataFormatMatcher

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

Exceptions

IOException:: for read I/O problems

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

withMaxInputLookahead	back to summary
public DataFormatDetector withMaxInputLookahead(int lookaheadBytes) Method that will return a detector instance that allows detectors to read up to specified number of bytes when determining format match strength. Parameters lookaheadBytes:int Amount of look-ahead allowed Returns:DataFormatDetector Format detector instance with specified lookahead settings

withMaxInputLookahead

back to summary

public DataFormatDetector withMaxInputLookahead(int lookaheadBytes)

Method that will return a detector instance that allows detectors to read up to specified number of bytes when determining format match strength.

Parameters

lookaheadBytes:int: Amount of look-ahead allowed

Returns:DataFormatDetector

Format detector instance with specified lookahead settings

withMinimalMatch	back to summary
public DataFormatDetector withMinimalMatch(MatchStrength minMatch) Method that will return a detector instance that uses given minimal match level; match that may be returned unless a stronger match is found with other format detectors. Parameters minMatch:MatchStrength Minimum match level to use Returns:DataFormatDetector Format detector instance with specified minimum match level

withMinimalMatch

back to summary

public DataFormatDetector withMinimalMatch(MatchStrength minMatch)

Method that will return a detector instance that uses given minimal match level; match that may be returned unless a stronger match is found with other format detectors.

Parameters

minMatch:MatchStrength: Minimum match level to use

Returns:DataFormatDetector

Format detector instance with specified minimum match level

withOptimalMatch	back to summary
public DataFormatDetector withOptimalMatch(MatchStrength optMatch) Method that will return a detector instance that uses given optimal match level (match that is considered sufficient to return, without trying to find stronger matches with other formats). Parameters optMatch:MatchStrength Optimal match level to use Returns:DataFormatDetector Format detector instance with specified optimal match level

withOptimalMatch

back to summary

public DataFormatDetector withOptimalMatch(MatchStrength optMatch)

Method that will return a detector instance that uses given optimal match level (match that is considered sufficient to return, without trying to find stronger matches with other formats).

Parameters

optMatch:MatchStrength: Optimal match level to use

Returns:DataFormatDetector

Format detector instance with specified optimal match level

public Class DataFormatDetector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail