- FieldAttributes - Class in com.google.gson
-
A data object that stores attributes of a field.
- FieldAttributes(Field) - Constructor for class com.google.gson.FieldAttributes
-
Constructs a Field Attributes object from the f
.
- FieldNamingPolicy - Enum in com.google.gson
-
An enumeration that defines a few standard naming conventions for JSON field names.
- FieldNamingStrategy - Interface in com.google.gson
-
A mechanism for providing custom field naming in Gson.
- fieldNamingStrategy() - Method in class com.google.gson.Gson
-
- flush() - Method in class com.google.gson.stream.JsonWriter
-
Ensures all buffered data is written to the underlying
Writer
and flushes that writer.
- fromJson(String, Class<T>) - Method in class com.google.gson.Gson
-
This method deserializes the specified Json into an object of the specified class.
- fromJson(String, Type) - Method in class com.google.gson.Gson
-
This method deserializes the specified Json into an object of the specified type.
- fromJson(Reader, Class<T>) - Method in class com.google.gson.Gson
-
This method deserializes the Json read from the specified reader into an object of the
specified class.
- fromJson(Reader, Type) - Method in class com.google.gson.Gson
-
This method deserializes the Json read from the specified reader into an object of the
specified type.
- fromJson(JsonReader, Type) - Method in class com.google.gson.Gson
-
Reads the next JSON value from reader
and convert it to an object
of type typeOfT
.
- fromJson(JsonElement, Class<T>) - Method in class com.google.gson.Gson
-
This method deserializes the Json read from the specified parse tree into an object of the
specified type.
- fromJson(JsonElement, Type) - Method in class com.google.gson.Gson
-
This method deserializes the Json read from the specified parse tree into an object of the
specified type.
- fromJson(Reader) - Method in class com.google.gson.TypeAdapter
-
Converts the JSON document in in
to a Java object.
- fromJson(String) - Method in class com.google.gson.TypeAdapter
-
Converts the JSON document in json
to a Java object.
- fromJsonTree(JsonElement) - Method in class com.google.gson.TypeAdapter
-
Converts jsonTree
to a Java object.
- generateNonExecutableJson() - Method in class com.google.gson.GsonBuilder
-
Makes the output JSON non-executable in Javascript by prefixing the generated JSON with some
special text.
- get(int) - Method in class com.google.gson.JsonArray
-
Returns the ith element of the array.
- get(String) - Method in class com.google.gson.JsonObject
-
Returns the member with the specified name.
- get(Type) - Static method in class com.google.gson.reflect.TypeToken
-
Gets type literal for the given Type
instance.
- get(Class<T>) - Static method in class com.google.gson.reflect.TypeToken
-
Gets type literal for the given Class
instance.
- getAdapter(TypeToken<T>) - Method in class com.google.gson.Gson
-
Returns the type adapter for type.
- getAdapter(Class<T>) - Method in class com.google.gson.Gson
-
Returns the type adapter for type.
- getAnnotation(Class<T>) - Method in class com.google.gson.FieldAttributes
-
Return the T
annotation object from this field if it exist; otherwise returns
null
.
- getAnnotations() - Method in class com.google.gson.FieldAttributes
-
Return the annotations that are present on this field.
- getArray(Type) - Static method in class com.google.gson.reflect.TypeToken
-
Gets type literal for the array type whose elements are all instances of componentType
.
- getAsBigDecimal() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a
BigDecimal
if it contains a single element.
- getAsBigDecimal() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a
BigDecimal
.
- getAsBigDecimal() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a
BigDecimal
.
- getAsBigInteger() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a
BigInteger
if it contains a single element.
- getAsBigInteger() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a
BigInteger
.
- getAsBigInteger() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a
BigInteger
.
- getAsBoolean() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a boolean if it contains a single element.
- getAsBoolean() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a boolean value.
- getAsBoolean() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a boolean value.
- getAsByte() - Method in class com.google.gson.JsonArray
-
- getAsByte() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive byte value.
- getAsByte() - Method in class com.google.gson.JsonPrimitive
-
- getAsCharacter() - Method in class com.google.gson.JsonArray
-
- getAsCharacter() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive character value.
- getAsCharacter() - Method in class com.google.gson.JsonPrimitive
-
- getAsDouble() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a double if it contains a single element.
- getAsDouble() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive double value.
- getAsDouble() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a primitive double.
- getAsFloat() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a float if it contains a single element.
- getAsFloat() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive float value.
- getAsFloat() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a float.
- getAsInt() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as an integer if it contains a single element.
- getAsInt() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive integer value.
- getAsInt() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a primitive integer.
- getAsJsonArray() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a
JsonArray
.
- getAsJsonArray(String) - Method in class com.google.gson.JsonObject
-
Convenience method to get the specified member as a JsonArray.
- getAsJsonNull() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a
JsonNull
.
- getAsJsonObject() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a
JsonObject
.
- getAsJsonObject(String) - Method in class com.google.gson.JsonObject
-
Convenience method to get the specified member as a JsonObject.
- getAsJsonPrimitive() - Method in class com.google.gson.JsonElement
-
- getAsJsonPrimitive(String) - Method in class com.google.gson.JsonObject
-
Convenience method to get the specified member as a JsonPrimitive element.
- getAsLong() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a long if it contains a single element.
- getAsLong() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive long value.
- getAsLong() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a primitive long.
- getAsNumber() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a
Number
if it contains a single element.
- getAsNumber() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a
Number
.
- getAsNumber() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a Number.
- getAsShort() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a primitive short if it contains a single element.
- getAsShort() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a primitive short value.
- getAsShort() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a primitive short.
- getAsString() - Method in class com.google.gson.JsonArray
-
convenience method to get this array as a
String
if it contains a single element.
- getAsString() - Method in class com.google.gson.JsonElement
-
convenience method to get this element as a string value.
- getAsString() - Method in class com.google.gson.JsonPrimitive
-
convenience method to get this element as a String.
- getDeclaredClass() - Method in class com.google.gson.FieldAttributes
-
Returns the Class
object that was declared for this field.
- getDeclaredType() - Method in class com.google.gson.FieldAttributes
-
For example, assume the following class definition:
public class Foo {
private String bar;
private List<String> red;
}
Type listParameterizedType = new TypeToken<List<String>>() {}.getType();
- getDeclaringClass() - Method in class com.google.gson.FieldAttributes
-
- getDelegateAdapter(TypeAdapterFactory, TypeToken<T>) - Method in class com.google.gson.Gson
-
This method is used to get an alternate type adapter for the specified type.
- getName() - Method in class com.google.gson.FieldAttributes
-
- getParameterized(Type, Type...) - Static method in class com.google.gson.reflect.TypeToken
-
Gets type literal for the parameterized type represented by applying typeArguments
to
rawType
.
- getPath() - Method in class com.google.gson.stream.JsonReader
-
Returns a
JsonPath to
the current location in the JSON value.
- getRawType() - Method in class com.google.gson.reflect.TypeToken
-
Returns the raw (non-generic) type for this type.
- getSerializeNulls() - Method in class com.google.gson.stream.JsonWriter
-
Returns true if object members are serialized when their value is null.
- getType() - Method in class com.google.gson.reflect.TypeToken
-
Gets underlying Type
instance.
- Gson - Class in com.google.gson
-
This is the main class for using Gson.
- Gson() - Constructor for class com.google.gson.Gson
-
Constructs a Gson object with default configuration.
- GsonBuilder - Class in com.google.gson
-
Use this builder to construct a
Gson
instance when you need to set configuration
options other than the default.
- GsonBuilder() - Constructor for class com.google.gson.GsonBuilder
-
Creates a GsonBuilder instance that can be used to build Gson with various configuration
settings.
- INSTANCE - Static variable in class com.google.gson.JsonNull
-
singleton for JsonNull
- InstanceCreator<T> - Interface in com.google.gson
-
This interface is implemented to create instances of a class that does not define a no-args
constructor.
- isAssignableFrom(Class<?>) - Method in class com.google.gson.reflect.TypeToken
-
- isAssignableFrom(Type) - Method in class com.google.gson.reflect.TypeToken
-
- isAssignableFrom(TypeToken<?>) - Method in class com.google.gson.reflect.TypeToken
-
- isBoolean() - Method in class com.google.gson.JsonPrimitive
-
Check whether this primitive contains a boolean value.
- isHtmlSafe() - Method in class com.google.gson.stream.JsonWriter
-
Returns true if this writer writes JSON that's safe for inclusion in HTML
and XML documents.
- isJsonArray() - Method in class com.google.gson.JsonElement
-
provides check for verifying if this element is an array or not.
- isJsonNull() - Method in class com.google.gson.JsonElement
-
provides check for verifying if this element represents a null value or not.
- isJsonObject() - Method in class com.google.gson.JsonElement
-
provides check for verifying if this element is a Json object or not.
- isJsonPrimitive() - Method in class com.google.gson.JsonElement
-
provides check for verifying if this element is a primitive or not.
- isLenient() - Method in class com.google.gson.stream.JsonReader
-
Returns true if this parser is liberal in what it accepts.
- isLenient() - Method in class com.google.gson.stream.JsonWriter
-
Returns true if this writer has relaxed syntax rules.
- isNumber() - Method in class com.google.gson.JsonPrimitive
-
Check whether this primitive contains a Number.
- isString() - Method in class com.google.gson.JsonPrimitive
-
Check whether this primitive contains a String value.
- iterator() - Method in class com.google.gson.JsonArray
-
Returns an iterator to navigate the elements of the array.
- JsonAdapter - Annotation Type in com.google.gson.annotations
-
An annotation that indicates the Gson
TypeAdapter
to use with a class
or field.
- JsonArray - Class in com.google.gson
-
A class representing an array type in Json.
- JsonArray() - Constructor for class com.google.gson.JsonArray
-
Creates an empty JsonArray.
- JsonArray(int) - Constructor for class com.google.gson.JsonArray
-
- JsonDeserializationContext - Interface in com.google.gson
-
- JsonDeserializer<T> - Interface in com.google.gson
-
Interface representing a custom deserializer for Json.
- JsonElement - Class in com.google.gson
-
A class representing an element of Json.
- JsonElement() - Constructor for class com.google.gson.JsonElement
-
- JsonIOException - Exception in com.google.gson
-
This exception is raised when Gson was unable to read an input stream
or write to one.
- JsonIOException(String) - Constructor for exception com.google.gson.JsonIOException
-
- JsonIOException(String, Throwable) - Constructor for exception com.google.gson.JsonIOException
-
- JsonIOException(Throwable) - Constructor for exception com.google.gson.JsonIOException
-
Creates exception with the specified cause.
- JsonNull - Class in com.google.gson
-
A class representing a Json null
value.
- JsonNull() - Constructor for class com.google.gson.JsonNull
-
Deprecated.
- JsonObject - Class in com.google.gson
-
A class representing an object type in Json.
- JsonObject() - Constructor for class com.google.gson.JsonObject
-
- JsonParseException - Exception in com.google.gson
-
This exception is raised if there is a serious issue that occurs during parsing of a Json
string.
- JsonParseException(String) - Constructor for exception com.google.gson.JsonParseException
-
Creates exception with the specified message.
- JsonParseException(String, Throwable) - Constructor for exception com.google.gson.JsonParseException
-
Creates exception with the specified message and cause.
- JsonParseException(Throwable) - Constructor for exception com.google.gson.JsonParseException
-
Creates exception with the specified cause.
- JsonParser - Class in com.google.gson
-
A parser to parse Json into a parse tree of
JsonElement
s
- JsonParser() - Constructor for class com.google.gson.JsonParser
-
- JsonPrimitive - Class in com.google.gson
-
A class representing a Json primitive value.
- JsonPrimitive(Boolean) - Constructor for class com.google.gson.JsonPrimitive
-
Create a primitive containing a boolean value.
- JsonPrimitive(Number) - Constructor for class com.google.gson.JsonPrimitive
-
Create a primitive containing a
Number
.
- JsonPrimitive(String) - Constructor for class com.google.gson.JsonPrimitive
-
Create a primitive containing a String value.
- JsonPrimitive(Character) - Constructor for class com.google.gson.JsonPrimitive
-
Create a primitive containing a character.
- JsonReader - Class in com.google.gson.stream
-
Reads a JSON (
RFC 7159)
encoded value as a stream of tokens.
- JsonReader(Reader) - Constructor for class com.google.gson.stream.JsonReader
-
Creates a new instance that reads a JSON-encoded stream from in
.
- JsonSerializationContext - Interface in com.google.gson
-
- JsonSerializer<T> - Interface in com.google.gson
-
Interface representing a custom serializer for Json.
- JsonStreamParser - Class in com.google.gson
-
A streaming parser that allows reading of multiple
JsonElement
s from the specified reader
asynchronously.
- JsonStreamParser(String) - Constructor for class com.google.gson.JsonStreamParser
-
- JsonStreamParser(Reader) - Constructor for class com.google.gson.JsonStreamParser
-
- JsonSyntaxException - Exception in com.google.gson
-
This exception is raised when Gson attempts to read (or write) a malformed
JSON element.
- JsonSyntaxException(String) - Constructor for exception com.google.gson.JsonSyntaxException
-
- JsonSyntaxException(String, Throwable) - Constructor for exception com.google.gson.JsonSyntaxException
-
- JsonSyntaxException(Throwable) - Constructor for exception com.google.gson.JsonSyntaxException
-
Creates exception with the specified cause.
- JsonToken - Enum in com.google.gson.stream
-
A structure, name or value type in a JSON-encoded string.
- jsonValue(String) - Method in class com.google.gson.stream.JsonWriter
-
Writes value
directly to the writer without quoting or
escaping.
- JsonWriter - Class in com.google.gson.stream
-
Writes a JSON (
RFC 7159)
encoded value to a stream, one token at a time.
- JsonWriter(Writer) - Constructor for class com.google.gson.stream.JsonWriter
-
Creates a new instance that writes a JSON-encoded stream to out
.
- serialize(Object) - Method in interface com.google.gson.JsonSerializationContext
-
Invokes default serialization on the specified object.
- serialize(Object, Type) - Method in interface com.google.gson.JsonSerializationContext
-
Invokes default serialization on the specified object passing the specific type information.
- serialize(T, Type, JsonSerializationContext) - Method in interface com.google.gson.JsonSerializer
-
Gson invokes this call-back method during serialization when it encounters a field of the
specified type.
- serialize(Long) - Method in enum com.google.gson.LongSerializationPolicy
-
Serialize this value
using this serialization policy.
- SerializedName - Annotation Type in com.google.gson.annotations
-
An annotation that indicates this member should be serialized to JSON with
the provided name value as its field name.
- serializeNulls() - Method in class com.google.gson.Gson
-
- serializeNulls() - Method in class com.google.gson.GsonBuilder
-
Configure Gson to serialize null fields.
- serializeSpecialFloatingPointValues() - Method in class com.google.gson.GsonBuilder
-
Section 2.4 of
JSON specification disallows
special double values (NaN, Infinity, -Infinity).
- set(int, JsonElement) - Method in class com.google.gson.JsonArray
-
Replaces the element at the specified position in this array with the specified element.
- setDateFormat(String) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to serialize Date
objects according to the pattern provided.
- setDateFormat(int) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to to serialize Date
objects according to the style value provided.
- setDateFormat(int, int) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to to serialize Date
objects according to the style value provided.
- setExclusionStrategies(ExclusionStrategy...) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a set of exclusion strategies during both serialization and
deserialization.
- setFieldNamingPolicy(FieldNamingPolicy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a specific naming policy to an object's field during serialization
and deserialization.
- setFieldNamingStrategy(FieldNamingStrategy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a specific naming policy strategy to an object's field during
serialization and deserialization.
- setHtmlSafe(boolean) - Method in class com.google.gson.stream.JsonWriter
-
Configure this writer to emit JSON that's safe for direct inclusion in HTML
and XML documents.
- setIndent(String) - Method in class com.google.gson.stream.JsonWriter
-
Sets the indentation string to be repeated for each level of indentation
in the encoded document.
- setLenient() - Method in class com.google.gson.GsonBuilder
-
By default, Gson is strict and only accepts JSON as specified by
RFC 4627.
- setLenient(boolean) - Method in class com.google.gson.stream.JsonReader
-
Configure this parser to be liberal in what it accepts.
- setLenient(boolean) - Method in class com.google.gson.stream.JsonWriter
-
Configure this writer to relax its syntax rules.
- setLongSerializationPolicy(LongSerializationPolicy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a specific serialization policy for Long
and long
objects.
- setPrettyPrinting() - Method in class com.google.gson.GsonBuilder
-
Configures Gson to output Json that fits in a page for pretty printing.
- setSerializeNulls(boolean) - Method in class com.google.gson.stream.JsonWriter
-
Sets whether object members are serialized when their value is null.
- setVersion(double) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to enable versioning support.
- shouldSkipClass(Class<?>) - Method in interface com.google.gson.ExclusionStrategy
-
- shouldSkipField(FieldAttributes) - Method in interface com.google.gson.ExclusionStrategy
-
- Since - Annotation Type in com.google.gson.annotations
-
An annotation that indicates the version number since a member or a type has been present.
- size() - Method in class com.google.gson.JsonArray
-
Returns the number of elements in the array.
- size() - Method in class com.google.gson.JsonObject
-
Returns the number of key/value pairs in the object.
- skipValue() - Method in class com.google.gson.stream.JsonReader
-
Skips the next value recursively.
- toJson(Object) - Method in class com.google.gson.Gson
-
This method serializes the specified object into its equivalent Json representation.
- toJson(Object, Type) - Method in class com.google.gson.Gson
-
This method serializes the specified object, including those of generic types, into its
equivalent Json representation.
- toJson(Object, Appendable) - Method in class com.google.gson.Gson
-
This method serializes the specified object into its equivalent Json representation.
- toJson(Object, Type, Appendable) - Method in class com.google.gson.Gson
-
This method serializes the specified object, including those of generic types, into its
equivalent Json representation.
- toJson(Object, Type, JsonWriter) - Method in class com.google.gson.Gson
-
Writes the JSON representation of src
of type typeOfSrc
to
writer
.
- toJson(JsonElement) - Method in class com.google.gson.Gson
-
Converts a tree of
JsonElement
s into its equivalent JSON representation.
- toJson(JsonElement, Appendable) - Method in class com.google.gson.Gson
-
Writes out the equivalent JSON for a tree of
JsonElement
s.
- toJson(JsonElement, JsonWriter) - Method in class com.google.gson.Gson
-
Writes the JSON for jsonElement
to writer
.
- toJson(Writer, T) - Method in class com.google.gson.TypeAdapter
-
Converts value
to a JSON document and writes it to out
.
- toJson(T) - Method in class com.google.gson.TypeAdapter
-
Converts value
to a JSON document.
- toJsonTree(Object) - Method in class com.google.gson.Gson
-
This method serializes the specified object into its equivalent representation as a tree of
JsonElement
s.
- toJsonTree(Object, Type) - Method in class com.google.gson.Gson
-
This method serializes the specified object, including those of generic types, into its
equivalent representation as a tree of
JsonElement
s.
- toJsonTree(T) - Method in class com.google.gson.TypeAdapter
-
Converts value
to a JSON tree.
- toString() - Method in class com.google.gson.Gson
-
- toString() - Method in class com.google.gson.JsonElement
-
Returns a String representation of this element.
- toString() - Method in class com.google.gson.reflect.TypeToken
-
- toString() - Method in class com.google.gson.stream.JsonReader
-
- translateName(Field) - Method in interface com.google.gson.FieldNamingStrategy
-
Translates the field name into its JSON field name representation.
- TypeAdapter<T> - Class in com.google.gson
-
Converts Java objects to and from JSON.
- TypeAdapter() - Constructor for class com.google.gson.TypeAdapter
-
- TypeAdapterFactory - Interface in com.google.gson
-
Creates type adapters for set of related types.
- TypeToken<T> - Class in com.google.gson.reflect
-
Represents a generic type T
.
- TypeToken() - Constructor for class com.google.gson.reflect.TypeToken
-
Constructs a new type literal.