com.fasterxml.jackson.dataformat.cbor

Enum CBORGenerator.Feature

java.lang.Object

java.lang.Enum<CBORGenerator.Feature>

com.fasterxml.jackson.dataformat.cbor.CBORGenerator.Feature

All Implemented Interfaces:

com.fasterxml.jackson.core.FormatFeature, com.fasterxml.jackson.core.util.JacksonFeature, Serializable, Comparable<CBORGenerator.Feature>

Enclosing class:

CBORGenerator

public static enum CBORGenerator.Feature
extends Enum<CBORGenerator.Feature>
implements com.fasterxml.jackson.core.FormatFeature

Enumeration that defines all togglable features for CBOR generator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING Feature that determines how binary tagged negative BigInteger values are encoded: either using CBOR standard encoding logic (as per spec), or using legacy Jackson encoding logic (encoding up to Jackson 2.19).
LENIENT_UTF_ENCODING Feature that determines if an invalid surrogate encoding found in the incoming String should fail with an exception or silently be output as the Unicode 'REPLACEMENT CHARACTER' (U+FFFD) or not; if not, an exception will be thrown to indicate invalid content.
STRINGREF Feature that determines if string references are generated based on the stringref) extension.
WRITE_MINIMAL_DOUBLES Feature that determines whether generator should try to write doubles as floats: if true, will write a double as a 4-byte float if no precision loss will occur; if false, will always write a double as an 8-byte double.
WRITE_MINIMAL_INTS Feature that determines whether generator should try to use smallest (size-wise) integer representation: if true, will use smallest representation that is enough to retain value; if false, will use length indicated by argument type (4-byte for int, 8-byte for long and so on).
WRITE_TYPE_HEADER Feature that determines whether CBOR "Self-Describe Tag" (value 55799, encoded as 3-byte sequence of 0xD9, 0xD9, 0xF7) should be written at the beginning of document or not.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_defaultState
protected int	_mask

Method Summary

Modifier and Type	Method and Description
static int	collectDefaults() Method that calculates bit set (flags) of all features that are enabled by default.
boolean	enabledByDefault()
boolean	enabledIn(int flags)
int	getMask()
static CBORGenerator.Feature	valueOf(String name) Returns the enum constant of this type with the specified name.
static CBORGenerator.Feature[]	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

WRITE_MINIMAL_INTS

public static final CBORGenerator.Feature WRITE_MINIMAL_INTS

Feature that determines whether generator should try to use smallest (size-wise) integer representation: if true, will use smallest representation that is enough to retain value; if false, will use length indicated by argument type (4-byte for int, 8-byte for long and so on).

WRITE_TYPE_HEADER

public static final CBORGenerator.Feature WRITE_TYPE_HEADER

Feature that determines whether CBOR "Self-Describe Tag" (value 55799, encoded as 3-byte sequence of 0xD9, 0xD9, 0xF7) should be written at the beginning of document or not.

Default value is false meaning that type tag will not be written at the beginning of a new document.

Since:

2.5

LENIENT_UTF_ENCODING

public static final CBORGenerator.Feature LENIENT_UTF_ENCODING

Feature that determines if an invalid surrogate encoding found in the incoming String should fail with an exception or silently be output as the Unicode 'REPLACEMENT CHARACTER' (U+FFFD) or not; if not, an exception will be thrown to indicate invalid content.

Default value is false (for backwards compatibility) meaning that an invalid surrogate will result in exception (IllegalArgumentException

Since:

2.12

STRINGREF

public static final CBORGenerator.Feature STRINGREF

Feature that determines if string references are generated based on the stringref) extension. This can save storage space, parsing time, and pool string memory when parsing. Readers of the output must also support the stringref extension to properly decode the data. Extra overhead may be added to generation time and memory usage to compute the shared binary and text strings.

Default value is false meaning that the stringref extension will not be used.

Since:

2.15

WRITE_MINIMAL_DOUBLES

public static final CBORGenerator.Feature WRITE_MINIMAL_DOUBLES

Feature that determines whether generator should try to write doubles as floats: if true, will write a double as a 4-byte float if no precision loss will occur; if false, will always write a double as an 8-byte double.

Default value is false meaning that doubles will always be written as 8-byte values.

Since:

2.15

ENCODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING

public static final CBORGenerator.Feature ENCODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING

Feature that determines how binary tagged negative BigInteger values are encoded: either using CBOR standard encoding logic (as per spec), or using legacy Jackson encoding logic (encoding up to Jackson 2.19). When enabled, uses CBOR standard specified encoding of negative values (e.g., -1 is encoded [0xC3, 0x41, 0x00]). When disabled, maintains backwards compatibility with existing implementations (e.g., -1 is encoded [0xC3, 0x41, 0x01]) and uses legacy Jackson encoding.

Note that there is the counterpart CBORParser.Feature.DECODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING for encoding.

Default value is false for backwards-compatibility.

Since:

2.20

Field Detail

_defaultState

protected final boolean _defaultState

_mask

protected final int _mask

Method Detail

values

public static CBORGenerator.Feature[] 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 (CBORGenerator.Feature c : CBORGenerator.Feature.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CBORGenerator.Feature 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

collectDefaults

public static int collectDefaults()

Method that calculates bit set (flags) of all features that are enabled by default.

enabledByDefault

public boolean enabledByDefault()

Specified by:

enabledByDefault in interface com.fasterxml.jackson.core.FormatFeature

Specified by:

enabledByDefault in interface com.fasterxml.jackson.core.util.JacksonFeature

enabledIn

public boolean enabledIn(int flags)

Specified by:

enabledIn in interface com.fasterxml.jackson.core.FormatFeature

Specified by:

enabledIn in interface com.fasterxml.jackson.core.util.JacksonFeature

getMask

public int getMask()

Specified by:

getMask in interface com.fasterxml.jackson.core.FormatFeature

Specified by:

getMask in interface com.fasterxml.jackson.core.util.JacksonFeature