public enum

FieldNamingPolicy

extends Enum<E extends Enum<E>>
implements FieldNamingStrategy
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ com.google.gson.FieldNamingPolicy

Class Overview

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.

Summary

Enum Values
FieldNamingPolicy  IDENTITY  Using this naming policy with Gson will ensure that the field name is unchanged. 
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 (-). 
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 (_). 
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. 
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. 
Public Methods
static FieldNamingPolicy valueOf(String name)
final static FieldNamingPolicy[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface com.google.gson.FieldNamingStrategy
From interface java.lang.Comparable

Enum Values

public static final FieldNamingPolicy IDENTITY

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

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.

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

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

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

Public Methods

public static FieldNamingPolicy valueOf (String name)

public static final FieldNamingPolicy[] values ()