org.codehaus.jackson.annotate

枚举 JsonTypeInfo.Id

java.lang.Object

java.lang.Enum<JsonTypeInfo.Id>

org.codehaus.jackson.annotate.JsonTypeInfo.Id

所有已实现的接口:

Serializable, Comparable<JsonTypeInfo.Id>

封闭类:

JsonTypeInfo

public static enum JsonTypeInfo.Id
extends Enum<JsonTypeInfo.Id>

Definition of different type identifiers that can be included in JSON during serialization, and used for deserialization.

枚举常量概要

枚举常量

枚举常量和说明
CLASS Means that fully-qualified Java class name is used as the type identifier.
CUSTOM Means that typing mechanism uses customized handling, with possibly custom configuration.
MINIMAL_CLASS Means that Java class name with minimal path is used as the type identifier.
NAME Means that logical type name is used as type information; name will then need to be separately resolved to actual concrete type (Class).
NONE This means that no explicit type metadata is included, and typing is purely done using contextual information possibly augmented with other annotations.

方法概要

方法

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

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

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

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

NONE

public static final JsonTypeInfo.Id NONE

This means that no explicit type metadata is included, and typing is purely done using contextual information possibly augmented with other annotations.

Note: no TypeIdResolver is constructed if this value is used.

CLASS

public static final JsonTypeInfo.Id CLASS

Means that fully-qualified Java class name is used as the type identifier.

MINIMAL_CLASS

public static final JsonTypeInfo.Id MINIMAL_CLASS

Means that Java class name with minimal path is used as the type identifier. Minimal means that only the class name, and that part of preceding Java package name is included that is needed to construct fully-qualified name given fully-qualified name of the declared supertype; additionally a single leading dot ('.') must be used to indicate that partial class name is used. For example, for supertype "com.foobar.Base", and concrete type "com.foo.Impl", only ".Impl" would be included; and for "com.foo.impl.Impl2" only ".impl.Impl2" would be included.
NOTE: leading dot ('.') MUST be used to denote partial (minimal) name; if it is missing, value is assumed to be fully-qualified name. Fully-qualified name is used in cases where subtypes are not in same package (or sub-package thereof) as base class.

If all related classes are in the same Java package, this option can reduce amount of type information overhead, especially for small types. However, please note that using this alternative is inherently risky since it assumes that the supertype can be reliably detected. Given that it is based on declared type (since ultimate supertype, java.lang.Object would not be very useful reference point), this may not always work as expected.

NAME

public static final JsonTypeInfo.Id NAME

Means that logical type name is used as type information; name will then need to be separately resolved to actual concrete type (Class).

CUSTOM

public static final JsonTypeInfo.Id CUSTOM

Means that typing mechanism uses customized handling, with possibly custom configuration. This means that semantics of other properties is not defined by Jackson package, but by the custom implementation.

方法详细资料

values

public static JsonTypeInfo.Id[] values()

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

for (JsonTypeInfo.Id c : JsonTypeInfo.Id.values())
    System.out.println(c);

valueOf

public static JsonTypeInfo.Id valueOf(String name)

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

参数:

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

返回:

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

抛出:

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

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

getDefaultPropertyName

public String getDefaultPropertyName()