Class DataFormatMatcher
- java.lang.Object
-
- com.fasterxml.jackson.core.format.DataFormatMatcher
-
public class DataFormatMatcher extends 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()
Convenience method for trying to construct aJsonParser
for parsing content which is assumed to be in detected data format.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.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.
-
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 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 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:
IOException
-
getDataStream
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.
-
-