Module tools.jackson.dataformat.avro

Package tools.jackson.dataformat.avro

Enum Class AvroWriteFeature

java.lang.Object

java.lang.Enum<AvroWriteFeature>

tools.jackson.dataformat.avro.AvroWriteFeature

All Implemented Interfaces:

Serializable, Comparable<AvroWriteFeature>, Constable, tools.jackson.core.FormatFeature, tools.jackson.core.util.JacksonFeature

public enum AvroWriteFeature
extends Enum<AvroWriteFeature>
implements tools.jackson.core.FormatFeature

Enumeration that defines all togglable features for Avro generators

NOTE: in Jackson 2.x this was named AvroGenerator.Feature.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD_NULL_AS_DEFAULT_VALUE_IN_SCHEMA	Feature that enables addition of null as default value in generated schema when no real default value is defined and null is legal value for type (union type with null included).
AVRO_BUFFERING	Feature that can be disabled to prevent Avro from buffering any more data then absolutely necessary.
AVRO_FILE_OUTPUT	Feature that tells Avro to write data in file format (i.e. including the schema with the data) rather than the RPC format which is otherwise default

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()
boolean	enabledIn(int flags)
int	getMask()
static AvroWriteFeature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AvroWriteFeature[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AVRO_BUFFERING

public static final AvroWriteFeature AVRO_BUFFERING

Feature that can be disabled to prevent Avro from buffering any more data then absolutely necessary. This affects buffering by underlying codec. Note that disabling buffer is likely to reduce performance if the underlying input/output is unbuffered.

Enabled by default to preserve the existing behavior.

AVRO_FILE_OUTPUT

public static final AvroWriteFeature AVRO_FILE_OUTPUT

Feature that tells Avro to write data in file format (i.e. including the schema with the data) rather than the RPC format which is otherwise default

NOTE: reader-side will have to be aware of distinction as well, since possible inclusion of this header is not 100% reliably auto-detectable (while header has distinct marker, "raw" Avro content has no limitations and could theoretically have same pre-amble from data).

ADD_NULL_AS_DEFAULT_VALUE_IN_SCHEMA

public static final AvroWriteFeature ADD_NULL_AS_DEFAULT_VALUE_IN_SCHEMA

Feature that enables addition of null as default value in generated schema when no real default value is defined and null is legal value for type (union type with null included).

Disabled by default.

Since:

3.0

Method Details

values

public static AvroWriteFeature[] 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 AvroWriteFeature 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.

enabledByDefault

public boolean enabledByDefault()

Specified by:

enabledByDefault in interface tools.jackson.core.util.JacksonFeature

getMask

public int getMask()

Specified by:

getMask in interface tools.jackson.core.util.JacksonFeature

enabledIn

public boolean enabledIn(int flags)

Specified by:

enabledIn in interface tools.jackson.core.util.JacksonFeature