Enum JsonSerialize.Inclusion
- java.lang.Object
-
- java.lang.Enum<JsonSerialize.Inclusion>
-
- org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<JsonSerialize.Inclusion>
- Enclosing class:
- JsonSerialize
public static enum JsonSerialize.Inclusion extends java.lang.Enum<JsonSerialize.Inclusion>
Enumeration used withJsonSerialize.include()
property to define which properties of Java Beans are to be included in serialization- Since:
- 1.1
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALWAYS
Value that indicates that properties are to be always included, independent of valueNON_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_EMPTY
Value that indicates that only properties that have values that values that are null or what is considered empty are not to be included.NON_NULL
Value that indicates that only properties with non-null values are to be included.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static JsonSerialize.Inclusion
valueOf(java.lang.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.
-
-
-
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 withMap
s, since they have no default values; and if used, works same asALWAYS
.
-
NON_EMPTY
public static final JsonSerialize.Inclusion NON_EMPTY
Value that indicates that only properties that have values that values that are null or what is considered empty are not to be included. Emptiness is defined for following type:- For
Collection
s andMap
s, methodisEmpty()
is called; - For Java arrays, empty arrays are ones with length of 0
- For Java
String
s,length()
is called, and return value of 0 indicates empty String (note thatString.isEmpty()
was added in Java 1.6 and as such can not be used by Jackson
-
For other types, non-null values are to be included.
- Since:
- 1.9
- For
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-