Enum StreamReadCapability
- All Implemented Interfaces:
JacksonFeature
,Serializable
,Comparable<StreamReadCapability>
,java.lang.constant.Constable
JsonParser
for given format
(or in case of buffering, original format) has.
Used in some cases to adjust aspects of things like content conversions,
coercions and validation by format-agnostic functionality.
Specific or expected usage documented by individual capability entry
Javadocs.- Since:
- 2.12
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionCapability that indicates that data format can expose multiple properties with same name ("duplicates") within one Object context.Capability that indicates whether data format supports reporting of accurate floating point values (with respect to reported numeric type,JsonParser.NumberType.DOUBLE
) or not.Capability that indicates that data format may in some cases expose Scalar values (whether typed or untyped) as Object values.Capability that indicates that data format only exposed "untyped" scalars: that is, instead of Number, Boolean and String types all scalar values are reported as text (JsonToken.VALUE_STRING
) unless some sort of coercion is implied by caller. -
Method Summary
Modifier and TypeMethodDescriptionboolean
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 form1 << N
.static StreamReadCapability
Returns the enum constant of this type with the specified name.static StreamReadCapability[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
DUPLICATE_PROPERTIES
Capability that indicates that data format can expose multiple properties with same name ("duplicates") within one Object context. This is usually not enabled, except for formats likexml
that have content model that does not map cleanly to JSON-based token stream.Capability may be used for allowing secondary mapping of such duplicates in case of using Tree Model (see
TreeNode
), or "untyped" databinding (mapping content as genericObject
).Capability is currently only enabled for XML format backend.
-
SCALARS_AS_OBJECTS
Capability that indicates that data format may in some cases expose Scalar values (whether typed or untyped) as Object values. There are additional access methods at databind level: this capability may be used to decide whether to attempt to use such methods especially in potentially ambiguous cases.Capability is currently only enabled for XML format backend.
-
UNTYPED_SCALARS
Capability that indicates that data format only exposed "untyped" scalars: that is, instead of Number, Boolean and String types all scalar values are reported as text (JsonToken.VALUE_STRING
) unless some sort of coercion is implied by caller.This capability is true for many textual formats like CSV, Properties and XML.
-
EXACT_FLOATS
Capability that indicates whether data format supports reporting of accurate floating point values (with respect to reported numeric type,JsonParser.NumberType.DOUBLE
) or not. This usually depends on whether format stores such values natively (as IEEE binary FP formats forjava.lang.Float
andjava.lang.Double
; using some other value preserving presentation forjava.math.BigDecimal
) or not: most binary formats do, and most textual formats do not (at least forFloat
andDouble
, specifically).In case of JSON numbers (as well as for most if not all textual formats), all floating-point numbers are represented simply by decimal (10-base) textual representation and can only be represented accurately using
BigDecimal
. But for performance reasons they may be (depending on settings) be exposed asDouble
s (that is,JsonParser.NumberType.DOUBLE
). Note that methods likeJsonParser.getNumberValueExact()
,JsonParser.getValueAsString()
andJsonParser.getDecimalValue()
report values without precision loss.The main intended use case is to let non-Jackson code to handle cases where exact accuracy is necessary in a way that handling does not incur unnecessary conversions across different formats: for example, when reading binary format, simple access is essentially guaranteed to expose value exactly as encoded by the format (as
float
,double
orBigDecimal
), whereas for textual formats like JSON it is necessary to access value explicitly asBigDecimal
usingJsonParser#getDecimalValue
.Capability is false for text formats like JSON, but true for binary formats like Smile, MessagePack, etc., where type is precisely and inexpensively indicated by format.
- Since:
- 2.14
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
enabledByDefault
public boolean enabledByDefault()Description copied from interface:JacksonFeature
Accessor for checking whether this feature is enabled by default.- Specified by:
enabledByDefault
in interfaceJacksonFeature
- 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 interfaceJacksonFeature
- Parameters:
flags
- Bit field 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 form1 << N
.- Specified by:
getMask
in interfaceJacksonFeature
- Returns:
- Bit mask of this feature
-