org.codehaus.jackson.map.annotate
Enum JsonSerialize.Inclusion

java.lang.Object
  extended by java.lang.Enum<JsonSerialize.Inclusion>
      extended by org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion
All Implemented Interfaces:
Serializable, Comparable<JsonSerialize.Inclusion>
Enclosing class:
JsonSerialize

public static enum JsonSerialize.Inclusion
extends Enum<JsonSerialize.Inclusion>

Enumeration used with JsonSerialize.include() property to define which properties of Java Beans are to be included in serialization


Enum Constant Summary
ALWAYS
          Value that indicates that properties are to be always included, independent of value
NON_DEFAULT
          Value that indicates that only properties that have values that differ from default settings (meaning values they have when Bean is constructed with its no-arguments constructor) are to be included.
NON_NULL
          Value that indicates that only properties with non-null values are to be included.
 
Method Summary
static JsonSerialize.Inclusion valueOf(String name)
          Returns the enum constant of this type with the specified name.
static JsonSerialize.Inclusion[] 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

ALWAYS

public static final JsonSerialize.Inclusion ALWAYS
Value that indicates that properties are to be always included, independent of value


NON_NULL

public static final JsonSerialize.Inclusion NON_NULL
Value that indicates that only properties with non-null values are to be included.


NON_DEFAULT

public static final JsonSerialize.Inclusion NON_DEFAULT
Value that indicates that only properties that have values that differ from default settings (meaning values they have when Bean is constructed with its no-arguments constructor) are to be included. Value is generally not useful with Maps, since they have no default values; and if used, works same as ALWAYS.

Method Detail

values

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

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

valueOf

public static JsonSerialize.Inclusion 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