- java.lang.Object
-
- com.google.gson.Gson
-
public final class Gson extends Object
This is the main class for using Gson. Gson is typically used by first constructing a Gson instance and then invokingtoJson(Object)orfromJson(String, Class)methods on it. Gson instances are Thread-safe so you can reuse them freely across multiple threads.You can create a Gson instance by invoking
new Gson()if the default configuration is all you need. You can also useGsonBuilderto build a Gson instance with various configuration options such as versioning support, pretty printing, customJsonSerializers,JsonDeserializers, andInstanceCreators.Here is an example of how Gson is used for a simple Class:
Gson gson = new Gson(); // Or use new GsonBuilder().create(); MyType target = new MyType(); String json = gson.toJson(target); // serializes target to Json MyType target2 = gson.fromJson(json, MyType.class); // deserializes json into target2
If the object that your are serializing/deserializing is a
ParameterizedType(i.e. contains at least one type parameter and may be an array) then you must use thetoJson(Object, Type)orfromJson(String, Type)method. Here is an example for serializing and deserializing aParameterizedType:Type listType = new TypeToken<List<String>>() {}.getType(); List<String> target = new LinkedList<String>(); target.add("blah"); Gson gson = new Gson(); String json = gson.toJson(target, listType); List<String> target2 = gson.fromJson(json, listType);See the Gson User Guide for a more complete set of examples.
- Author:
- Inderjeet Singh, Joel Leitch, Jesse Wilson
- See Also:
TypeToken
-
-
Constructor Summary
Constructors Constructor Description Gson()Constructs a Gson object with default configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description com.google.gson.internal.Excluderexcluder()Deprecated.This method by accident exposes an internal Gson class; it might be removed in a future version.FieldNamingStrategyfieldNamingStrategy()Returns the field naming strategy used by this Gson instance.<T> TfromJson(JsonElement json, Class<T> classOfT)This method deserializes the Json read from the specified parse tree into an object of the specified type.<T> TfromJson(JsonElement json, Type typeOfT)This method deserializes the Json read from the specified parse tree into an object of the specified type.<T> TfromJson(JsonReader reader, Type typeOfT)Reads the next JSON value fromreaderand convert it to an object of typetypeOfT.<T> TfromJson(Reader json, Class<T> classOfT)This method deserializes the Json read from the specified reader into an object of the specified class.<T> TfromJson(Reader json, Type typeOfT)This method deserializes the Json read from the specified reader into an object of the specified type.<T> TfromJson(String json, Class<T> classOfT)This method deserializes the specified Json into an object of the specified class.<T> TfromJson(String json, Type typeOfT)This method deserializes the specified Json into an object of the specified type.<T> TypeAdapter<T>getAdapter(TypeToken<T> type)Returns the type adapter for type.<T> TypeAdapter<T>getAdapter(Class<T> type)Returns the type adapter for type.<T> TypeAdapter<T>getDelegateAdapter(TypeAdapterFactory skipPast, TypeToken<T> type)This method is used to get an alternate type adapter for the specified type.booleanhtmlSafe()Returns whether this Gson instance produces JSON output which is HTML-safe, that means all HTML characters are escaped.GsonBuildernewBuilder()Returns a new GsonBuilder containing all custom factories and configuration used by the current instance.JsonReadernewJsonReader(Reader reader)Returns a new JSON reader configured for the settings on this Gson instance.JsonWriternewJsonWriter(Writer writer)Returns a new JSON writer configured for the settings on this Gson instance.booleanserializeNulls()Returns whether this Gson instance is serializing JSON object properties withnullvalues, or just omits them.StringtoJson(JsonElement jsonElement)Converts a tree ofJsonElements into its equivalent JSON representation.voidtoJson(JsonElement jsonElement, JsonWriter writer)Writes the JSON forjsonElementtowriter.voidtoJson(JsonElement jsonElement, Appendable writer)Writes out the equivalent JSON for a tree ofJsonElements.StringtoJson(Object src)This method serializes the specified object into its equivalent Json representation.voidtoJson(Object src, Appendable writer)This method serializes the specified object into its equivalent Json representation.StringtoJson(Object src, Type typeOfSrc)This method serializes the specified object, including those of generic types, into its equivalent Json representation.voidtoJson(Object src, Type typeOfSrc, JsonWriter writer)Writes the JSON representation ofsrcof typetypeOfSrctowriter.voidtoJson(Object src, Type typeOfSrc, Appendable writer)This method serializes the specified object, including those of generic types, into its equivalent Json representation.JsonElementtoJsonTree(Object src)This method serializes the specified object into its equivalent representation as a tree ofJsonElements.JsonElementtoJsonTree(Object src, Type typeOfSrc)This method serializes the specified object, including those of generic types, into its equivalent representation as a tree ofJsonElements.StringtoString()
-
-
-
Constructor Detail
-
Gson
public Gson()
Constructs a Gson object with default configuration. The default configuration has the following settings:- The JSON generated by
toJsonmethods is in compact representation. This means that all the unneeded white-space is removed. You can change this behavior withGsonBuilder.setPrettyPrinting(). - The generated JSON omits all the fields that are null. Note that nulls in arrays are
kept as is since an array is an ordered list. Moreover, if a field is not null, but its
generated JSON is empty, the field is kept. You can configure Gson to serialize null values
by setting
GsonBuilder.serializeNulls(). - Gson provides default serialization and deserialization for Enums,
Map,URL,URI,Locale,Date,BigDecimal, andBigIntegerclasses. If you would prefer to change the default representation, you can do so by registering a type adapter throughGsonBuilder.registerTypeAdapter(Type, Object). - The default Date format is same as
DateFormat.DEFAULT. This format ignores the millisecond portion of the date during serialization. You can change this by invokingGsonBuilder.setDateFormat(int)orGsonBuilder.setDateFormat(String). - By default, Gson ignores the
Exposeannotation. You can enable Gson to serialize/deserialize only those fields marked with this annotation throughGsonBuilder.excludeFieldsWithoutExposeAnnotation(). - By default, Gson ignores the
Sinceannotation. You can enable Gson to use this annotation throughGsonBuilder.setVersion(double). - The default field naming policy for the output Json is same as in Java. So, a Java class
field
versionNumberwill be output as"versionNumber"in Json. The same rules are applied for mapping incoming Json to the Java classes. You can change this policy throughGsonBuilder.setFieldNamingPolicy(FieldNamingPolicy). - By default, Gson excludes
transientorstaticfields from consideration for serialization and deserialization. You can change this behavior throughGsonBuilder.excludeFieldsWithModifiers(int...).
- The JSON generated by
-
-
Method Detail
-
newBuilder
public GsonBuilder newBuilder()
Returns a new GsonBuilder containing all custom factories and configuration used by the current instance.- Returns:
- a GsonBuilder instance.
-
excluder
@Deprecated public com.google.gson.internal.Excluder excluder()
Deprecated.This method by accident exposes an internal Gson class; it might be removed in a future version.
-
fieldNamingStrategy
public FieldNamingStrategy fieldNamingStrategy()
Returns the field naming strategy used by this Gson instance.
-
serializeNulls
public boolean serializeNulls()
Returns whether this Gson instance is serializing JSON object properties withnullvalues, or just omits them.- See Also:
GsonBuilder.serializeNulls()
-
htmlSafe
public boolean htmlSafe()
Returns whether this Gson instance produces JSON output which is HTML-safe, that means all HTML characters are escaped.- See Also:
GsonBuilder.disableHtmlEscaping()
-
getAdapter
public <T> TypeAdapter<T> getAdapter(TypeToken<T> type)
Returns the type adapter for type.- Throws:
IllegalArgumentException- if this GSON cannot serialize and deserializetype.
-
getDelegateAdapter
public <T> TypeAdapter<T> getDelegateAdapter(TypeAdapterFactory skipPast, TypeToken<T> type)
This method is used to get an alternate type adapter for the specified type. This is used to access a type adapter that is overridden by aTypeAdapterFactorythat you may have registered. This features is typically used when you want to register a type adapter that does a little bit of work but then delegates further processing to the Gson default type adapter. Here is an example:Let's say we want to write a type adapter that counts the number of objects being read from or written to JSON. We can achieve this by writing a type adapter factory that uses the
getDelegateAdaptermethod:
This factory can now be used like this:class StatsTypeAdapterFactory implements TypeAdapterFactory { public int numReads = 0; public int numWrites = 0; public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) { final TypeAdapter<T> delegate = gson.getDelegateAdapter(this, type); return new TypeAdapter<T>() { public void write(JsonWriter out, T value) throws IOException { ++numWrites; delegate.write(out, value); } public T read(JsonReader in) throws IOException { ++numReads; return delegate.read(in); } }; } }
Note that this call will skip all factories registered beforeStatsTypeAdapterFactory stats = new StatsTypeAdapterFactory(); Gson gson = new GsonBuilder().registerTypeAdapterFactory(stats).create(); // Call gson.toJson() and fromJson methods on objects System.out.println("Num JSON reads" + stats.numReads); System.out.println("Num JSON writes" + stats.numWrites);skipPast. In case of multiple TypeAdapterFactories registered it is up to the caller of this function to insure that the order of registration does not prevent this method from reaching a factory they would expect to reply from this call. Note that since you can not override type adapter factories for String and Java primitive types, our stats factory will not count the number of String or primitives that will be read or written.- Parameters:
skipPast- The type adapter factory that needs to be skipped while searching for a matching type adapter. In most cases, you should just pass this (the type adapter factory from wheregetDelegateAdapter(com.google.gson.TypeAdapterFactory, com.google.gson.reflect.TypeToken<T>)method is being invoked).type- Type for which the delegate adapter is being searched for.- Since:
- 2.2
-
getAdapter
public <T> TypeAdapter<T> getAdapter(Class<T> type)
Returns the type adapter for type.- Throws:
IllegalArgumentException- if this GSON cannot serialize and deserializetype.
-
toJsonTree
public JsonElement toJsonTree(Object src)
This method serializes the specified object into its equivalent representation as a tree ofJsonElements. This method should be used when the specified object is not a generic type. This method usesObject.getClass()to get the type for the specified object, but thegetClass()loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, usetoJsonTree(Object, Type)instead.- Parameters:
src- the object for which Json representation is to be created setting for Gson- Returns:
- Json representation of
src. - Since:
- 1.4
-
toJsonTree
public JsonElement toJsonTree(Object src, Type typeOfSrc)
This method serializes the specified object, including those of generic types, into its equivalent representation as a tree ofJsonElements. This method must be used if the specified object is a generic type. For non-generic objects, usetoJsonTree(Object)instead.- Parameters:
src- the object for which JSON representation is to be createdtypeOfSrc- The specific genericized type of src. You can obtain this type by using theTypeTokenclass. For example, to get the type forCollection<Foo>, you should use:Type typeOfSrc = new TypeToken<Collection<Foo>>(){}.getType();- Returns:
- Json representation of
src - Since:
- 1.4
-
toJson
public String toJson(Object src)
This method serializes the specified object into its equivalent Json representation. This method should be used when the specified object is not a generic type. This method usesObject.getClass()to get the type for the specified object, but thegetClass()loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, usetoJson(Object, Type)instead. If you want to write out the object to aWriter, usetoJson(Object, Appendable)instead.- Parameters:
src- the object for which Json representation is to be created setting for Gson- Returns:
- Json representation of
src.
-
toJson
public String toJson(Object src, Type typeOfSrc)
This method serializes the specified object, including those of generic types, into its equivalent Json representation. This method must be used if the specified object is a generic type. For non-generic objects, usetoJson(Object)instead. If you want to write out the object to aAppendable, usetoJson(Object, Type, Appendable)instead.- Parameters:
src- the object for which JSON representation is to be createdtypeOfSrc- The specific genericized type of src. You can obtain this type by using theTypeTokenclass. For example, to get the type forCollection<Foo>, you should use:Type typeOfSrc = new TypeToken<Collection<Foo>>(){}.getType();- Returns:
- Json representation of
src
-
toJson
public void toJson(Object src, Appendable writer) throws JsonIOException
This method serializes the specified object into its equivalent Json representation. This method should be used when the specified object is not a generic type. This method usesObject.getClass()to get the type for the specified object, but thegetClass()loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, usetoJson(Object, Type, Appendable)instead.- Parameters:
src- the object for which Json representation is to be created setting for Gsonwriter- Writer to which the Json representation needs to be written- Throws:
JsonIOException- if there was a problem writing to the writer- Since:
- 1.2
-
toJson
public void toJson(Object src, Type typeOfSrc, Appendable writer) throws JsonIOException
This method serializes the specified object, including those of generic types, into its equivalent Json representation. This method must be used if the specified object is a generic type. For non-generic objects, usetoJson(Object, Appendable)instead.- Parameters:
src- the object for which JSON representation is to be createdtypeOfSrc- The specific genericized type of src. You can obtain this type by using theTypeTokenclass. For example, to get the type forCollection<Foo>, you should use:Type typeOfSrc = new TypeToken<Collection<Foo>>(){}.getType();writer- Writer to which the Json representation of src needs to be written.- Throws:
JsonIOException- if there was a problem writing to the writer- Since:
- 1.2
-
toJson
public void toJson(Object src, Type typeOfSrc, JsonWriter writer) throws JsonIOException
Writes the JSON representation ofsrcof typetypeOfSrctowriter.- Throws:
JsonIOException- if there was a problem writing to the writer
-
toJson
public String toJson(JsonElement jsonElement)
Converts a tree ofJsonElements into its equivalent JSON representation.- Parameters:
jsonElement- root of a tree ofJsonElements- Returns:
- JSON String representation of the tree
- Since:
- 1.4
-
toJson
public void toJson(JsonElement jsonElement, Appendable writer) throws JsonIOException
Writes out the equivalent JSON for a tree ofJsonElements.- Parameters:
jsonElement- root of a tree ofJsonElementswriter- Writer to which the Json representation needs to be written- Throws:
JsonIOException- if there was a problem writing to the writer- Since:
- 1.4
-
newJsonWriter
public JsonWriter newJsonWriter(Writer writer) throws IOException
Returns a new JSON writer configured for the settings on this Gson instance.- Throws:
IOException
-
newJsonReader
public JsonReader newJsonReader(Reader reader)
Returns a new JSON reader configured for the settings on this Gson instance.
-
toJson
public void toJson(JsonElement jsonElement, JsonWriter writer) throws JsonIOException
Writes the JSON forjsonElementtowriter.- Throws:
JsonIOException- if there was a problem writing to the writer
-
fromJson
public <T> T fromJson(String json, Class<T> classOfT) throws JsonSyntaxException
This method deserializes the specified Json into an object of the specified class. It is not suitable to use if the specified class is a generic type since it will not have the generic type information because of the Type Erasure feature of Java. Therefore, this method should not be used if the desired type is a generic type. Note that this method works fine if the any of the fields of the specified object are generics, just the object itself should not be a generic type. For the cases when the object is of generic type, invokefromJson(String, Type). If you have the Json in aReaderinstead of a String, usefromJson(Reader, Class)instead.- Type Parameters:
T- the type of the desired object- Parameters:
json- the string from which the object is to be deserializedclassOfT- the class of T- Returns:
- an object of type T from the string. Returns
nullifjsonisnullor ifjsonis empty. - Throws:
JsonSyntaxException- if json is not a valid representation for an object of type classOfT
-
fromJson
public <T> T fromJson(String json, Type typeOfT) throws JsonSyntaxException
This method deserializes the specified Json into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, usefromJson(String, Class)instead. If you have the Json in aReaderinstead of a String, usefromJson(Reader, Type)instead.- Type Parameters:
T- the type of the desired object- Parameters:
json- the string from which the object is to be deserializedtypeOfT- The specific genericized type of src. You can obtain this type by using theTypeTokenclass. For example, to get the type forCollection<Foo>, you should use:Type typeOfT = new TypeToken<Collection<Foo>>(){}.getType();- Returns:
- an object of type T from the string. Returns
nullifjsonisnullor ifjsonis empty. - Throws:
JsonParseException- if json is not a valid representation for an object of type typeOfTJsonSyntaxException- if json is not a valid representation for an object of type
-
fromJson
public <T> T fromJson(Reader json, Class<T> classOfT) throws JsonSyntaxException, JsonIOException
This method deserializes the Json read from the specified reader into an object of the specified class. It is not suitable to use if the specified class is a generic type since it will not have the generic type information because of the Type Erasure feature of Java. Therefore, this method should not be used if the desired type is a generic type. Note that this method works fine if the any of the fields of the specified object are generics, just the object itself should not be a generic type. For the cases when the object is of generic type, invokefromJson(Reader, Type). If you have the Json in a String form instead of aReader, usefromJson(String, Class)instead.- Type Parameters:
T- the type of the desired object- Parameters:
json- the reader producing the Json from which the object is to be deserialized.classOfT- the class of T- Returns:
- an object of type T from the string. Returns
nullifjsonis at EOF. - Throws:
JsonIOException- if there was a problem reading from the ReaderJsonSyntaxException- if json is not a valid representation for an object of type- Since:
- 1.2
-
fromJson
public <T> T fromJson(Reader json, Type typeOfT) throws JsonIOException, JsonSyntaxException
This method deserializes the Json read from the specified reader into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, usefromJson(Reader, Class)instead. If you have the Json in a String form instead of aReader, usefromJson(String, Type)instead.- Type Parameters:
T- the type of the desired object- Parameters:
json- the reader producing Json from which the object is to be deserializedtypeOfT- The specific genericized type of src. You can obtain this type by using theTypeTokenclass. For example, to get the type forCollection<Foo>, you should use:Type typeOfT = new TypeToken<Collection<Foo>>(){}.getType();- Returns:
- an object of type T from the json. Returns
nullifjsonis at EOF. - Throws:
JsonIOException- if there was a problem reading from the ReaderJsonSyntaxException- if json is not a valid representation for an object of type- Since:
- 1.2
-
fromJson
public <T> T fromJson(JsonReader reader, Type typeOfT) throws JsonIOException, JsonSyntaxException
Reads the next JSON value fromreaderand convert it to an object of typetypeOfT. Returnsnull, if thereaderis at EOF. Since Type is not parameterized by T, this method is type unsafe and should be used carefully- Throws:
JsonIOException- if there was a problem writing to the ReaderJsonSyntaxException- if json is not a valid representation for an object of type
-
fromJson
public <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException
This method deserializes the Json read from the specified parse tree into an object of the specified type. It is not suitable to use if the specified class is a generic type since it will not have the generic type information because of the Type Erasure feature of Java. Therefore, this method should not be used if the desired type is a generic type. Note that this method works fine if the any of the fields of the specified object are generics, just the object itself should not be a generic type. For the cases when the object is of generic type, invokefromJson(JsonElement, Type).- Type Parameters:
T- the type of the desired object- Parameters:
json- the root of the parse tree ofJsonElements from which the object is to be deserializedclassOfT- The class of T- Returns:
- an object of type T from the json. Returns
nullifjsonisnullor ifjsonis empty. - Throws:
JsonSyntaxException- if json is not a valid representation for an object of type typeOfT- Since:
- 1.3
-
fromJson
public <T> T fromJson(JsonElement json, Type typeOfT) throws JsonSyntaxException
This method deserializes the Json read from the specified parse tree into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, usefromJson(JsonElement, Class)instead.- Type Parameters:
T- the type of the desired object- Parameters:
json- the root of the parse tree ofJsonElements from which the object is to be deserializedtypeOfT- The specific genericized type of src. You can obtain this type by using theTypeTokenclass. For example, to get the type forCollection<Foo>, you should use:Type typeOfT = new TypeToken<Collection<Foo>>(){}.getType();- Returns:
- an object of type T from the json. Returns
nullifjsonisnullor ifjsonis empty. - Throws:
JsonSyntaxException- if json is not a valid representation for an object of type typeOfT- Since:
- 1.3
-
-