StreamReadCapability (jackson-core 2.13.3)

java.lang.Object
- java.lang.Enum<StreamReadCapability>
- - com.fasterxml.jackson.core.StreamReadCapability

All Implemented Interfaces:

JacksonFeature, Serializable, Comparable<StreamReadCapability>
```
public enum StreamReadCapability
extends Enum<StreamReadCapability>
implements JacksonFeature
```
Set of on/off capabilities that a 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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DUPLICATE_PROPERTIES` Capability that indicates that data format can expose multiple properties with same name ("duplicates") within one Object context.
`SCALARS_AS_OBJECTS` Capability that indicates that data format may in some cases expose Scalar values (whether typed or untyped) as Object values.
`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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 StreamReadCapability`	`valueOf(String name)` 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.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DUPLICATE_PROPERTIES
```
public static final StreamReadCapability 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 like xml 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 generic Object).
    Capability is currently only enabled for XML format backend.
  - SCALARS_AS_OBJECTS
```
public static final StreamReadCapability 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
```
public static final StreamReadCapability 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.
- Method Detail
  - values
```
public static StreamReadCapability[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (StreamReadCapability c : StreamReadCapability.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StreamReadCapability valueOf(String name)
```
    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 name
    
    NullPointerException - 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 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 - 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 form 1 << N.
    
    Specified by:
    
    getMask in interface JacksonFeature
    
    Returns:
    
    Bit mask of this feature

Enum StreamReadCapability

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DUPLICATE_PROPERTIES

SCALARS_AS_OBJECTS

UNTYPED_SCALARS

Method Detail

values

valueOf

enabledByDefault

enabledIn

getMask