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.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JsonParser
createParserWithMatch()
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.
-
-
-
Method Detail
-
hasMatch
public boolean hasMatch()
Accessor to use to see if any formats matched well enough with the input data.- Returns:
- Whether format has a match
-
getMatchStrength
public MatchStrength getMatchStrength()
Method for accessing strength of the match, if any; if no match, will returnMatchStrength.INCONCLUSIVE
.- Returns:
- Strength of match
-
getMatch
public JsonFactory getMatch()
Accessor forJsonFactory
that represents format that data matched.- Returns:
- Relevant
JsonFactory
to indicate matched format
-
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;
- Returns:
- Name of the format that is acceptable match, if any;
null
if none
-
createParserWithMatch
public JsonParser createParserWithMatch() throws java.io.IOException
- 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.- Returns:
- InputStream to use for reading actual content using format detected
-
-