Top Description Methods
com.google.gson.annotations

public @Interface SerializedName

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:FIELD, METHOD
Imports
java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target

An annotation that indicates this member should be serialized to JSON with the provided name value as its field name.

This annotation will override any com.google.gson.FieldNamingPolicy, including the default field naming policy, that may have been set on the com.google.gson.Gson instance. A different naming policy can set using the GsonBuilder class. See com.google.gson.GsonBuilder#setFieldNamingPolicy(com.google.gson.FieldNamingPolicy) for more information.

Here is an example of how this annotation is meant to be used:

public class MyClass {
  @SerializedName("name") String a;
  @SerializedName(value="name1", alternate={"name2", "name3"}) String b;
  String c;

  public MyClass(String a, String b, String c) {
    this.a = a;
    this.b = b;
    this.c = c;
  }
}

The following shows the output that is generated when serializing an instance of the above example class:

MyClass target = new MyClass("v1", "v2", "v3");
Gson gson = new Gson();
String json = gson.toJson(target);
System.out.println(json);

===== OUTPUT =====
{"name":"v1","name1":"v2","c":"v3"}

Note

The value you specify in this annotation must be a valid JSON field name. While deserializing, all values specified in the annotation will be deserialized into the field. For example:

  MyClass target = gson.fromJson("{'name1':'v1'}", MyClass.class);
  assertEquals("v1", target.b);
  target = gson.fromJson("{'name2':'v2'}", MyClass.class);
  assertEquals("v2", target.b);
  target = gson.fromJson("{'name3':'v3'}", MyClass.class);
  assertEquals("v3", target.b);
Note that MyClass.b is now deserialized from either name1, name2 or name3.
Authors
Inderjeet Singh, Joel Leitch
See Also
com.google.gson.FieldNamingPolicy

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

the alternative names of the field when it is deserialized
alternate
()

The alternative names of the field when it is deserialized

public String

Returns:

the desired name of the field when it is serialized or deserialized
value
()

The desired name of the field when it is serialized or deserialized.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

alternateback to summary
public String[] alternate()

The alternative names of the field when it is deserialized

Returns:String[]

the alternative names of the field when it is deserialized

valueback to summary
public String value()

The desired name of the field when it is serialized or deserialized.

Returns:String

the desired name of the field when it is serialized or deserialized