org.codehaus.jackson.annotate

枚举 JsonMethod

java.lang.Object

java.lang.Enum<JsonMethod>

org.codehaus.jackson.annotate.JsonMethod

所有已实现的接口:

Serializable, Comparable<JsonMethod>

public enum JsonMethod
extends Enum<JsonMethod>

Enumeration used to define kinds of methods that annotations like JsonAutoDetect apply to.

In addition to actual method types (GETTER, SETTER, CREATOR; and sort-of-method, FIELD), 2 pseudo-types are defined for convenience: ALWAYS and NONE. These can be used to indicate, all or none of available method types (respectively), for use by annotations that takes JsonMethod argument.

枚举常量概要

枚举常量

枚举常量和说明
ALL This pseudo-type indicates that all of real types are included
CREATOR Creators are constructors and (static) factory methods used to construct POJO instances for deserialization
FIELD Field refers to fields of regular Java objects.
GETTER Getters are methods used to get a POJO field value for serialization, or, under certain conditions also for de-serialization.
IS_GETTER "Is getters" are getter-like methods that are named "isXxx" (instead of "getXxx" for getters) and return boolean value (either primitive, or Boolean).
NONE This pseudo-type indicates that none of real types is included
SETTER Setters are methods used to set a POJO value for deserialization.

方法概要

方法

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

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

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

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

GETTER

public static final JsonMethod GETTER

Getters are methods used to get a POJO field value for serialization, or, under certain conditions also for de-serialization. Latter can be used for effectively setting Collection or Map values in absence of setters, iff returned value is not a copy but actual value of the logical property.

Since version 1.3, this does NOT include "is getters" (methods that return boolean and named 'isXxx' for property 'xxx'); instead, IS_GETTER is used}.

SETTER

public static final JsonMethod SETTER

Setters are methods used to set a POJO value for deserialization.

CREATOR

public static final JsonMethod CREATOR

Creators are constructors and (static) factory methods used to construct POJO instances for deserialization

FIELD

public static final JsonMethod FIELD

Field refers to fields of regular Java objects. Although they are not really methods, addition of optional field-discovery in version 1.1 meant that there was need to enable/disable their auto-detection, and this is the place to add it in.

从以下版本开始:

1.1

IS_GETTER

public static final JsonMethod IS_GETTER

"Is getters" are getter-like methods that are named "isXxx" (instead of "getXxx" for getters) and return boolean value (either primitive, or Boolean).

从以下版本开始:

1.3

NONE

public static final JsonMethod NONE

This pseudo-type indicates that none of real types is included

ALL

public static final JsonMethod ALL

This pseudo-type indicates that all of real types are included

方法详细资料

values

public static JsonMethod[] values()

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

for (JsonMethod c : JsonMethod.values())
    System.out.println(c);

valueOf

public static JsonMethod valueOf(String name)

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

参数:

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

返回:

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

抛出:

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

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

creatorEnabled

public boolean creatorEnabled()

getterEnabled

public boolean getterEnabled()

isGetterEnabled

public boolean isGetterEnabled()

setterEnabled

public boolean setterEnabled()

fieldEnabled

public boolean fieldEnabled()