Enum Class StreamReadFeature

java.lang.Object
java.lang.Enum<StreamReadFeature>
tools.jackson.core.StreamReadFeature
All Implemented Interfaces:
Serializable, Comparable<StreamReadFeature>, Constable, JacksonFeature
public enum StreamReadFeature extends Enum<StreamReadFeature> implements JacksonFeature
Token reader (parser) features not-specific to any particular format backend.

NOTE: Jackson 2.x contained these along with JSON-specific features in JsonParser.Feature.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTO_CLOSE_SOURCE
    Feature that determines whether parser will automatically close underlying input source that is NOT owned by the parser.
    CLEAR_CURRENT_TOKEN_ON_CLOSE
    Feature that determines whether parser will clear "current token" (accessible via JsonParser#currentToken()) when it is closed (via JsonParser.close()).
    IGNORE_UNDEFINED
    Feature that determines what to do if the underlying data format requires knowledge of all properties to decode (usually via a Schema), and if no definition is found for a property that input content contains.
    INCLUDE_SOURCE_IN_LOCATION
    Feature that determines whether TokenStreamLocation instances should be constructed with reference to source or not.
    STRICT_DUPLICATE_DETECTION
    Feature that determines whether JsonParser will explicitly check that no duplicate JSON Object Property names are encountered.
    USE_FAST_BIG_NUMBER_PARSER
    Feature that determines whether to use the built-in JDK code for parsing BigDecimal and BigIntegers values (if disabled) or FastDoubleParser implementation (if enabled).
    USE_FAST_DOUBLE_PARSER
    Feature that determines whether to use the built-in JDK Double.parseDouble(String) code to parse doubles (if disabled) or FastDoubleParser implementation (if enabled).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final boolean
    _defaultState
    Whether feature is enabled or disabled by default.
    private final int
    _mask
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    StreamReadFeature(boolean defaultState)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    collectDefaults()
    Method that calculates bit set (flags) of all features that are enabled by default.
    boolean
    enabledByDefault()
    Accessor for checking whether this feature is enabled by default.
    boolean
    enabledIn(int flags)
    Convenience method for checking whether feature is enabled in given bitmask.
    int
    getMask()
    Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.
    static StreamReadFeature
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static StreamReadFeature[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AUTO_CLOSE_SOURCE

      public static final StreamReadFeature AUTO_CLOSE_SOURCE
      Feature that determines whether parser will automatically close underlying input source that is NOT owned by the parser. If disabled, calling application has to separately close the underlying InputStream and Reader instances used to create the parser. If enabled, parser will handle closing, as long as parser itself gets closed: this happens when end-of-input is encountered, or parser is closed by a call to JsonParser.close().

      Feature is enabled by default.

    • IGNORE_UNDEFINED

      public static final StreamReadFeature IGNORE_UNDEFINED
      Feature that determines what to do if the underlying data format requires knowledge of all properties to decode (usually via a Schema), and if no definition is found for a property that input content contains. Typically most textual data formats do NOT require schema information (although some do, such as CSV), whereas many binary data formats do require definitions (such as Avro, protobuf), although not all (Smile, CBOR, BSON and MessagePack do not). Further note that some formats that do require schema information will not be able to ignore undefined properties: for example, Avro is fully positional and there is no possibility of undefined data. This leaves formats like Protobuf that have identifiers that may or may not map; and as such Protobuf format does make use of this feature.

      Note that support for this feature is implemented by individual data format module, if (and only if) it makes sense for the format in question. For JSON, for example, this feature has no effect as properties need not be pre-defined.

      Feature is disabled by default, meaning that if the underlying data format requires knowledge of all properties to output, attempts to read an unknown property will result in an exception (typically of type StreamReadException).

    • STRICT_DUPLICATE_DETECTION

      public static final StreamReadFeature STRICT_DUPLICATE_DETECTION
      Feature that determines whether JsonParser will explicitly check that no duplicate JSON Object Property names are encountered. If enabled, parser will check all names within context and report duplicates by throwing a StreamReadException; if disabled, parser will not do such checking. Assumption in latter case is that caller takes care of handling duplicates at a higher level: data-binding, for example, has features to specify detection to be done there.

      Note that enabling this feature will incur performance overhead due to having to store and check additional information: this typically adds 20-30% to execution time for basic parsing.

    • CLEAR_CURRENT_TOKEN_ON_CLOSE

      public static final StreamReadFeature CLEAR_CURRENT_TOKEN_ON_CLOSE
      Feature that determines whether parser will clear "current token" (accessible via JsonParser#currentToken()) when it is closed (via JsonParser.close()).

      Feature is enabled by default.

    • INCLUDE_SOURCE_IN_LOCATION

      public static final StreamReadFeature INCLUDE_SOURCE_IN_LOCATION
      Feature that determines whether TokenStreamLocation instances should be constructed with reference to source or not. If source reference is included, its type and contents are included when `toString()` method is called (most notably when printing out parse exception with that location information). If feature is disabled, no source reference is passed and source is only indicated as "REDACTED".

      Most common reason for disabling this feature is to avoid leaking internal information; this may be done for security reasons. Note that even if source reference is included, only parts of contents are usually printed, and not the whole contents. Further, many source reference types cannot necessarily access contents (like streams), so only type is indicated, not contents.

      Feature is disabled by default for security reasons (to avoid leaking additional source information), meaning that "source reference" information is NOT passed and none of source content will be included in TokenStreamLocation constructed either when requested explicitly, or when needed for an exception.

    • USE_FAST_BIG_NUMBER_PARSER

      public static final StreamReadFeature USE_FAST_BIG_NUMBER_PARSER
      Feature that determines whether to use the built-in JDK code for parsing BigDecimal and BigIntegers values (if disabled) or FastDoubleParser implementation (if enabled).

      This setting is enabled by default (since 3.0) so that FastDoubleParser implementation is used.

    • USE_FAST_DOUBLE_PARSER

      public static final StreamReadFeature USE_FAST_DOUBLE_PARSER
      Feature that determines whether to use the built-in JDK Double.parseDouble(String) code to parse doubles (if disabled) or FastDoubleParser implementation (if enabled).

      This setting is enabled by default (since 3.0) so that FastDoubleParser implementation is used.

  • Field Details

    • _defaultState

      private final boolean _defaultState
      Whether feature is enabled or disabled by default.

    • _mask

      private final int _mask

  • Constructor Details

    • StreamReadFeature

      private StreamReadFeature(boolean defaultState)

  • Method Details

    • values

      public static StreamReadFeature[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static StreamReadFeature valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • collectDefaults

      public static int collectDefaults()
      Method that calculates bit set (flags) of all features that are enabled by default.
      Returns:
      Bit mask of all features that are enabled by default

    • enabledByDefault

      public boolean enabledByDefault()
      Description copied from interface: JacksonFeature
      Accessor for checking whether this feature is enabled by default.
      Specified by:
      enabledByDefault in interface JacksonFeature
      Returns:
      Whether this instance is enabled by default or not

    • enabledIn

      public boolean enabledIn(int flags)
      Description copied from interface: JacksonFeature
      Convenience method for checking whether feature is enabled in given bitmask.
      Specified by:
      enabledIn in interface JacksonFeature
      Parameters:
      flags - Bitfield that contains a set of enabled features of this type
      Returns:
      True if this feature is enabled in passed bit field

    • getMask

      public int getMask()
      Description copied from interface: JacksonFeature
      Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.
      Specified by:
      getMask in interface JacksonFeature
      Returns:
      Bit mask of this feature