com.google.gson

枚举 FieldNamingPolicy

java.lang.Object

java.lang.Enum<FieldNamingPolicy>

com.google.gson.FieldNamingPolicy

所有已实现的接口:

FieldNamingStrategy, Serializable, Comparable<FieldNamingPolicy>

public enum FieldNamingPolicy
extends Enum<FieldNamingPolicy>
implements FieldNamingStrategy

An enumeration that defines a few standard naming conventions for JSON field names. This enumeration should be used in conjunction with GsonBuilder to configure a Gson instance to properly translate Java field names into the desired JSON field names.

枚举常量概要

枚举常量

枚举常量和说明
IDENTITY Using this naming policy with Gson will ensure that the field name is unchanged.
LOWER_CASE_WITH_DASHES Using this naming policy with Gson will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by a dash (-).
LOWER_CASE_WITH_UNDERSCORES Using this naming policy with Gson will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by an underscore (_).
UPPER_CAMEL_CASE Using this naming policy with Gson will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form.
UPPER_CAMEL_CASE_WITH_SPACES Using this naming policy with Gson will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form and the words will be separated by a space.

方法概要

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

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

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

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

getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.gson.FieldNamingStrategy

translateName

枚举常量详细资料

IDENTITY

public static final FieldNamingPolicy IDENTITY

Using this naming policy with Gson will ensure that the field name is unchanged.

UPPER_CAMEL_CASE

public static final FieldNamingPolicy UPPER_CAMEL_CASE

Using this naming policy with Gson will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form.

Here's a few examples of the form "Java Field Name" ---> "JSON Field Name":

• someFieldName ---> SomeFieldName
• _someFieldName ---> _SomeFieldName

UPPER_CAMEL_CASE_WITH_SPACES

public static final FieldNamingPolicy UPPER_CAMEL_CASE_WITH_SPACES

Using this naming policy with Gson will ensure that the first "letter" of the Java field name is capitalized when serialized to its JSON form and the words will be separated by a space.

Here's a few examples of the form "Java Field Name" ---> "JSON Field Name":

• someFieldName ---> Some Field Name
• _someFieldName ---> _Some Field Name

从以下版本开始:

1.4

LOWER_CASE_WITH_UNDERSCORES

public static final FieldNamingPolicy LOWER_CASE_WITH_UNDERSCORES

Using this naming policy with Gson will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by an underscore (_).

Here's a few examples of the form "Java Field Name" ---> "JSON Field Name":

• someFieldName ---> some_field_name
• _someFieldName ---> _some_field_name
• aStringField ---> a_string_field
• aURL ---> a_u_r_l

LOWER_CASE_WITH_DASHES

public static final FieldNamingPolicy LOWER_CASE_WITH_DASHES

Using this naming policy with Gson will modify the Java Field name from its camel cased form to a lower case field name where each word is separated by a dash (-).

Here's a few examples of the form "Java Field Name" ---> "JSON Field Name":

• someFieldName ---> some-field-name
• _someFieldName ---> _some-field-name
• aStringField ---> a-string-field
• aURL ---> a-u-r-l

Using dashes in JavaScript is not recommended since dash is also used for a minus sign in expressions. This requires that a field named with dashes is always accessed as a quoted property like myobject['my-field']. Accessing it as an object field myobject.my-field will result in an unintended javascript expression.

从以下版本开始:

1.4

方法详细资料

values

public static FieldNamingPolicy[] values()

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

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

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static FieldNamingPolicy valueOf(String name)

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

参数:

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

返回:

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

抛出:

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

NullPointerException - 如果参数为空值