org.codehaus.jackson.map.annotate

枚举 JsonSerialize.Inclusion

java.lang.Object

java.lang.Enum<JsonSerialize.Inclusion>

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

所有已实现的接口:

Serializable, Comparable<JsonSerialize.Inclusion>

封闭类:

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

从以下版本开始:

1.1

枚举常量概要

枚举常量

枚举常量和说明
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_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.

方法概要

方法

限定符和类型	方法和说明
static JsonSerialize.Inclusion	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static JsonSerialize.Inclusion[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

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

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

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.

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 Collections and Maps, method isEmpty() is called;
• For Java arrays, empty arrays are ones with length of 0
• For Java Strings, length() is called, and return value of 0 indicates empty String (note that String.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.

从以下版本开始:

1.9

方法详细资料

values

public static JsonSerialize.Inclusion[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (JsonSerialize.Inclusion c : JsonSerialize.Inclusion.values())
    System.out.println(c);

valueOf

public static JsonSerialize.Inclusion valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

如果该枚举类型没有带有指定名称的常量, - 则抛出 IllegalArgumentException

如果参数为空值, - 则抛出 NullPointerException