Class DataFormatReaders.Match

java.lang.Object
com.fasterxml.jackson.databind.deser.DataFormatReaders.Match
Enclosing class:
DataFormatReaders

public static class DataFormatReaders.Match extends Object
Result class, similar to DataFormatMatcher
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final byte[]
    Content read during format matching process
    protected final int
    Number of bytes available in buffer.
    protected final int
    Pointer to the first byte in buffer available for reading
    protected final ObjectReader
    Factory that produced sufficient match (if any)
    protected final com.fasterxml.jackson.core.format.MatchStrength
    Strength of match with _match
    protected final InputStream
     
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Match(InputStream in, byte[] buffered, int bufferedStart, int bufferedLength, ObjectReader match, com.fasterxml.jackson.core.format.MatchStrength strength)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.core.JsonParser
    Convenience method for trying to construct a JsonParser for parsing content which is assumed to be in detected data format.
    Method to use for accessing input for which format detection has been done.
    Accessor for getting brief textual name of matched format if any (null if none).
    com.fasterxml.jackson.core.format.MatchStrength
    Method for accessing strength of the match, if any; if no match, will return MatchStrength.INCONCLUSIVE.
    Accessor for JsonFactory that represents format that data matched.
    boolean
    Accessor to use to see if any formats matched well enough with the input data.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • _originalStream

      protected final 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 ObjectReader _match
      Factory that produced sufficient match (if any)
    • _matchStrength

      protected final com.fasterxml.jackson.core.format.MatchStrength _matchStrength
      Strength of match with _match
  • Constructor Details

    • Match

      protected Match(InputStream in, byte[] buffered, int bufferedStart, int bufferedLength, ObjectReader match, com.fasterxml.jackson.core.format.MatchStrength strength)
  • Method Details

    • hasMatch

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

      public com.fasterxml.jackson.core.format.MatchStrength getMatchStrength()
      Method for accessing strength of the match, if any; if no match, will return MatchStrength.INCONCLUSIVE.
    • getReader

      public ObjectReader getReader()
      Accessor for JsonFactory 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 com.fasterxml.jackson.core.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.
      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.