Class DataFormatMatcher
- java.lang.Object
-
- com.fasterxml.jackson.core.format.DataFormatMatcher
-
public class DataFormatMatcher extends java.lang.Object
Result object constructed byDataFormatDetector
when requested to detect format of given input data.
-
-
Field Summary
Fields Modifier and Type Field Description protected byte[]
_bufferedData
Content read during format matching processprotected int
_bufferedLength
Number of bytes available in buffer.protected int
_bufferedStart
Pointer to the first byte in buffer available for readingprotected JsonFactory
_match
Factory that produced sufficient match (if any)protected MatchStrength
_matchStrength
Strength of match with_match
protected java.io.InputStream
_originalStream
-
Constructor Summary
Constructors Modifier Constructor Description protected
DataFormatMatcher(java.io.InputStream in, byte[] buffered, int bufferedStart, int bufferedLength, JsonFactory match, MatchStrength strength)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JsonParser
createParserWithMatch()
Convenience method for trying to construct aJsonParser
for parsing content which is assumed to be in detected data format.java.io.InputStream
getDataStream()
Method to use for accessing input for which format detection has been done.JsonFactory
getMatch()
Accessor forJsonFactory
that represents format that data matched.java.lang.String
getMatchedFormatName()
Accessor for getting brief textual name of matched format if any (null if none).MatchStrength
getMatchStrength()
Method for accessing strength of the match, if any; if no match, will returnMatchStrength.INCONCLUSIVE
.boolean
hasMatch()
Accessor to use to see if any formats matched well enough with the input data.
-
-
-
Field Detail
-
_originalStream
protected final java.io.InputStream _originalStream
-
_bufferedData
protected final byte[] _bufferedData
Content read during format matching process
-
_bufferedStart
protected final int _bufferedStart
Pointer to the first byte in buffer available for reading
-
_bufferedLength
protected final int _bufferedLength
Number of bytes available in buffer.
-
_match
protected final JsonFactory _match
Factory that produced sufficient match (if any)
-
_matchStrength
protected final MatchStrength _matchStrength
Strength of match with_match
-
-
Constructor Detail
-
DataFormatMatcher
protected DataFormatMatcher(java.io.InputStream in, byte[] buffered, int bufferedStart, int bufferedLength, JsonFactory match, MatchStrength strength)
-
-
Method Detail
-
hasMatch
public boolean hasMatch()
Accessor to use to see if any formats matched well enough with the input data.
-
getMatchStrength
public MatchStrength getMatchStrength()
Method for accessing strength of the match, if any; if no match, will returnMatchStrength.INCONCLUSIVE
.
-
getMatch
public JsonFactory getMatch()
Accessor forJsonFactory
that represents format that data matched.
-
getMatchedFormatName
public java.lang.String getMatchedFormatName()
Accessor for getting brief textual name of matched format if any (null if none). Equivalent to:return hasMatch() ? getMatch().getFormatName() : null;
-
createParserWithMatch
public JsonParser createParserWithMatch() throws java.io.IOException
Convenience method for trying to construct aJsonParser
for parsing content which is assumed to be in detected data format. If no match was found, returns null.- Throws:
java.io.IOException
-
getDataStream
public java.io.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.
-
-