Top Description Fields Constructors Methods
tools.jackson.dataformat.ion

public final Enum IonWriteFeature

extends Enum<IonWriteFeature>
implements FormatFeature
Class Inheritance
All Implemented Interfaces
tools.jackson.core.FormatFeature, tools.jackson.core.util.JacksonFeature
Imports
tools.jackson.core.FormatFeature
Enumeration that defines all toggleable features for Ion generators

Note

in Jackson 2.x this was named IonGenerator.Feature.

Field Summary

Modifier and TypeField and Description
private final boolean
_defaultState

private final int
_mask

public static final IonWriteFeature
USE_NATIVE_TYPE_ID

Whether to use Ion native Type Id construct for indicating type (true); or "generic" type property (false) when writing.

Constructor Summary

AccessConstructor and Description
private
IonWriteFeature(boolean defaultState)

Method Summary

Modifier and TypeMethod and Description
public static int
collectDefaults()

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

public boolean
enabledByDefault()

Implements tools.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

public boolean
enabledIn(int flags)

Implements tools.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

public int
getMask()

Implements tools.jackson.core.util.JacksonFeature.getMask.

Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.

public static IonWriteFeature
valueOf(String name)

public static IonWriteFeature[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

_defaultStateback to summary
private final boolean _defaultState
_maskback to summary
private final int _mask
USE_NATIVE_TYPE_IDback to summary
public static final IonWriteFeature USE_NATIVE_TYPE_ID

Whether to use Ion native Type Id construct for indicating type (true); or "generic" type property (false) when writing. Former works better for systems that are Ion-centric; latter may be better choice for interoperability, when converting between formats or accepting other formats.

Enabled by default.

See Also
The Ion Specification

Constructor Detail

IonWriteFeatureback to summary
private IonWriteFeature(boolean defaultState)

Method Detail

collectDefaultsback to summary
public static int collectDefaults()

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

enabledByDefaultback to summary
public boolean enabledByDefault()

Implements tools.jackson.core.util.JacksonFeature.enabledByDefault.

Doc from tools.jackson.core.util.JacksonFeature.enabledByDefault.

Accessor for checking whether this feature is enabled by default.

Annotations
@Override
enabledInback to summary
public boolean enabledIn(int flags)

Implements tools.jackson.core.util.JacksonFeature.enabledIn.

Doc from tools.jackson.core.util.JacksonFeature.enabledIn.

Convenience method for checking whether feature is enabled in given bitmask.

Annotations
@Override
getMaskback to summary
public int getMask()

Implements tools.jackson.core.util.JacksonFeature.getMask.

Doc from tools.jackson.core.util.JacksonFeature.getMask.

Returns bit mask for this feature instance; must be a single bit, that is of form 1 << N.

Annotations
@Override
valueOfback to summary
public static IonWriteFeature valueOf(String name)
valuesback to summary
public static IonWriteFeature[] values()