org.codehaus.jackson.map
Enum SerializationConfig.Feature

java.lang.Object
  java.lang.Enum<SerializationConfig.Feature>
      org.codehaus.jackson.map.SerializationConfig.Feature

All Implemented Interfaces:

Serializable, Comparable<SerializationConfig.Feature>

Enclosing class:

SerializationConfig

public static enum SerializationConfig.Feature
extends Enum<SerializationConfig.Feature>

Enumeration that defines togglable features that guide the serialization feature.

Enum Constant Summary

AUTO_DETECT_FIELDS
Feature that determines whether non-static fields are recognized as properties.

AUTO_DETECT_GETTERS
Feature that determines whether "getter" methods are automatically detected based on standard Bean naming convention or not.

CAN_OVERRIDE_ACCESS_MODIFIERS
Feature that determines whether method and field access modifier settings can be overridden when accessing properties.

INDENT_OUTPUT
Feature that allows enabling (or disabling) indentation for the underlying generator, using the default pretty printer (see JsonGenerator.useDefaultPrettyPrinter() for details).

WRITE_DATES_AS_TIMESTAMPS
Feature that determines whether Dates (and Date-based things like Calendars) are to be serialized as numeric timestamps (true; the default), or as textual representation (false).

WRITE_NULL_PROPERTIES
Deprecated. As of 1.1, use SerializationConfig.setSerializationInclusion(org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion)} instead

Method Summary

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

AUTO_DETECT_GETTERS

public static final SerializationConfig.Feature AUTO_DETECT_GETTERS

Feature that determines whether "getter" methods are automatically detected based on standard Bean naming convention or not. If yes, then all public zero-argument methods that start with prefix "get" (or, "is" if return type is boolean) are considered as getters. If disabled, only methods explicitly annotated are considered getters.

Note that this feature has lower precedence than per-class annotations, and is only used if there isn't more granular configuration available.

Feature is enabled by default.

AUTO_DETECT_FIELDS

public static final SerializationConfig.Feature AUTO_DETECT_FIELDS

Feature that determines whether non-static fields are recognized as properties. If yes, then all public member fields are considered as properties. If disabled, only fields explicitly annotated are considered property fields.

Note that this feature has lower precedence than per-class annotations, and is only used if there isn't more granular configuration available.

Feature is enabled by default.

Since:

1.1

CAN_OVERRIDE_ACCESS_MODIFIERS

public static final SerializationConfig.Feature CAN_OVERRIDE_ACCESS_MODIFIERS

Feature that determines whether method and field access modifier settings can be overridden when accessing properties. If enabled, method AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) may be called to enable access to otherwise unaccessible objects.

WRITE_NULL_PROPERTIES

public static final SerializationConfig.Feature WRITE_NULL_PROPERTIES

Deprecated. As of 1.1, use SerializationConfig.setSerializationInclusion(org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion)} instead

Feature that determines the default settings of whether Bean properties with null values are to be written out.

Feature is enabled by default (null properties written).

Note too that there is annotation JsonWriteNullProperties that can be used for more granular control (annotates bean classes or individual property access methods).

WRITE_DATES_AS_TIMESTAMPS

public static final SerializationConfig.Feature WRITE_DATES_AS_TIMESTAMPS

Feature that determines whether Dates (and Date-based things like Calendars) are to be serialized as numeric timestamps (true; the default), or as textual representation (false). If textual representation is used, the actual format is one returned by a call to SerializationConfig.getDateFormat().

INDENT_OUTPUT

public static final SerializationConfig.Feature INDENT_OUTPUT

Feature that allows enabling (or disabling) indentation for the underlying generator, using the default pretty printer (see JsonGenerator.useDefaultPrettyPrinter() for details).

Note that this only affects cases where JsonGenerator is constructed implicitly by ObjectMapper: if explicit generator is passed, its configuration is not changed.

Also note that if you want to configure details of indentation, you need to directly configure the generator: there is a method to use any PrettyPrinter instance. This feature will only allow using the default implementation.

Method Detail

values

public static SerializationConfig.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 (SerializationConfig.Feature c : SerializationConfig.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 SerializationConfig.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()

getMask

public int getMask()