A B C D E F G H I J K L M N P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- add(JsonElement) - Method in class com.google.gson.JsonArray
-
Adds the specified element to self.
- add(Boolean) - Method in class com.google.gson.JsonArray
-
Adds the specified boolean to self.
- add(Character) - Method in class com.google.gson.JsonArray
-
Adds the specified character to self.
- add(Number) - Method in class com.google.gson.JsonArray
-
Adds the specified number to self.
- add(String) - Method in class com.google.gson.JsonArray
-
Adds the specified string to self.
- add(String, JsonElement) - Method in class com.google.gson.JsonObject
-
Adds a member, which is a name-value pair, to self.
- addAll(JsonArray) - Method in class com.google.gson.JsonArray
-
Adds all the elements of the specified array to self.
- addDeserializationExclusionStrategy(ExclusionStrategy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply the passed in exclusion strategy during deserialization.
- addProperty(String, Boolean) - Method in class com.google.gson.JsonObject
-
Convenience method to add a boolean member.
- addProperty(String, Character) - Method in class com.google.gson.JsonObject
-
Convenience method to add a char member.
- addProperty(String, Number) - Method in class com.google.gson.JsonObject
-
Convenience method to add a number member.
- addProperty(String, String) - Method in class com.google.gson.JsonObject
-
Convenience method to add a string member.
- addReflectionAccessFilter(ReflectionAccessFilter) - Method in class com.google.gson.GsonBuilder
-
Adds a reflection access filter.
- addSerializationExclusionStrategy(ExclusionStrategy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply the passed in exclusion strategy during serialization.
- ALLOW - com.google.gson.ReflectionAccessFilter.FilterResult
-
Reflection access for the class is allowed.
- alternate() - Method in annotation type com.google.gson.annotations.SerializedName
- asList() - Method in class com.google.gson.JsonArray
-
Returns a mutable
List
view of thisJsonArray
. - asMap() - Method in class com.google.gson.JsonObject
-
Returns a mutable
Map
view of thisJsonObject
.
B
- BEGIN_ARRAY - com.google.gson.stream.JsonToken
-
The opening of a JSON array.
- BEGIN_OBJECT - com.google.gson.stream.JsonToken
-
The opening of a JSON object.
- beginArray() - Method in class com.google.gson.stream.JsonReader
-
Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.
- beginArray() - Method in class com.google.gson.stream.JsonWriter
-
Begins encoding a new array.
- beginObject() - Method in class com.google.gson.stream.JsonReader
-
Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.
- beginObject() - Method in class com.google.gson.stream.JsonWriter
-
Begins encoding a new object.
- BIG_DECIMAL - com.google.gson.ToNumberPolicy
-
Using this policy will ensure that numbers will be read as numbers of arbitrary length using
BigDecimal
. - BLOCK_ALL - com.google.gson.ReflectionAccessFilter.FilterResult
-
Blocks all reflection access for the class.
- BLOCK_ALL_ANDROID - Static variable in interface com.google.gson.ReflectionAccessFilter
-
Blocks all reflection access to members of standard Android classes.
- BLOCK_ALL_JAVA - Static variable in interface com.google.gson.ReflectionAccessFilter
-
Blocks all reflection access to members of standard Java classes.
- BLOCK_ALL_PLATFORM - Static variable in interface com.google.gson.ReflectionAccessFilter
-
Blocks all reflection access to members of classes belonging to programming language platforms, such as Java, Android, Kotlin or Scala.
- BLOCK_INACCESSIBLE - com.google.gson.ReflectionAccessFilter.FilterResult
-
Blocks reflection access if a member of the class is not accessible by default and would have to be made accessible.
- BLOCK_INACCESSIBLE_JAVA - Static variable in interface com.google.gson.ReflectionAccessFilter
-
Blocks all reflection access to members of standard Java classes which are not accessible by default.
- BOOLEAN - com.google.gson.stream.JsonToken
-
A JSON
true
orfalse
.
C
- check(Class<?>) - Method in interface com.google.gson.ReflectionAccessFilter
-
Checks if reflection access should be allowed for a class.
- close() - Method in class com.google.gson.stream.JsonReader
-
Closes this JSON reader and the underlying
Reader
. - close() - Method in class com.google.gson.stream.JsonWriter
-
Flushes and closes this writer and the underlying
Writer
. - com.google.gson - module com.google.gson
-
Defines the Gson serialization/deserialization API.
- com.google.gson - package com.google.gson
-
This package provides the
Gson
class to convert Json to Java and vice-versa. - com.google.gson.annotations - package com.google.gson.annotations
-
This package provides annotations that can be used with
Gson
. - com.google.gson.reflect - package com.google.gson.reflect
-
This package provides utility classes for finding type information for generic types.
- com.google.gson.stream - package com.google.gson.stream
-
This package provides classes for processing JSON in an efficient streaming way.
- contains(JsonElement) - Method in class com.google.gson.JsonArray
-
Returns true if this array contains the specified element.
- create() - Method in class com.google.gson.GsonBuilder
-
Creates a
Gson
instance based on the current configuration. - create(Gson, TypeToken<T>) - Method in interface com.google.gson.TypeAdapterFactory
-
Returns a type adapter for
type
, or null if this factory doesn't supporttype
. - createInstance(Type) - Method in interface com.google.gson.InstanceCreator
-
Gson invokes this call-back method during deserialization to create an instance of the specified type.
D
- deepCopy() - Method in class com.google.gson.JsonArray
-
Creates a deep copy of this element and all its children.
- deepCopy() - Method in class com.google.gson.JsonElement
-
Returns a deep copy of this element.
- deepCopy() - Method in class com.google.gson.JsonNull
-
Returns the same instance since it is an immutable value.
- deepCopy() - Method in class com.google.gson.JsonObject
-
Creates a deep copy of this element and all its children.
- deepCopy() - Method in class com.google.gson.JsonPrimitive
-
Returns the same value as primitives are immutable.
- DEFAULT - com.google.gson.LongSerializationPolicy
-
This is the "default" serialization policy that will output a
Long
object as a JSON number. - deserialize() - Method in annotation type com.google.gson.annotations.Expose
-
If
true
, the field marked with this annotation is deserialized from the JSON. - deserialize(JsonElement, Type) - Method in interface com.google.gson.JsonDeserializationContext
-
Invokes default deserialization on the specified object.
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in interface com.google.gson.JsonDeserializer
-
Gson invokes this call-back method during deserialization when it encounters a field of the specified type.
- disableHtmlEscaping() - Method in class com.google.gson.GsonBuilder
-
By default, Gson escapes HTML characters such as < > etc.
- disableInnerClassSerialization() - Method in class com.google.gson.GsonBuilder
-
Configures Gson to exclude inner classes (= non-
static
nested classes) during serialization and deserialization. - disableJdkUnsafe() - Method in class com.google.gson.GsonBuilder
-
Disables usage of JDK's
sun.misc.Unsafe
. - DOUBLE - com.google.gson.ToNumberPolicy
-
Using this policy will ensure that numbers will be read as
Double
values.
E
- enableComplexMapKeySerialization() - Method in class com.google.gson.GsonBuilder
-
Enabling this feature will only change the serialized form if the map key is a complex type (i.e.
- END_ARRAY - com.google.gson.stream.JsonToken
-
The closing of a JSON array.
- END_DOCUMENT - com.google.gson.stream.JsonToken
-
The end of the JSON stream.
- END_OBJECT - com.google.gson.stream.JsonToken
-
The closing of a JSON object.
- endArray() - Method in class com.google.gson.stream.JsonReader
-
Consumes the next token from the JSON stream and asserts that it is the end of the current array.
- endArray() - Method in class com.google.gson.stream.JsonWriter
-
Ends encoding the current array.
- endObject() - Method in class com.google.gson.stream.JsonReader
-
Consumes the next token from the JSON stream and asserts that it is the end of the current object.
- endObject() - Method in class com.google.gson.stream.JsonWriter
-
Ends encoding the current object.
- entrySet() - Method in class com.google.gson.JsonObject
-
Returns a set of members of this object.
- equals(Object) - Method in class com.google.gson.JsonArray
-
Returns whether the other object is equal to this.
- equals(Object) - Method in class com.google.gson.JsonNull
-
All instances of
JsonNull
are considered equal. - equals(Object) - Method in class com.google.gson.JsonObject
-
Returns whether the other object is equal to this.
- equals(Object) - Method in class com.google.gson.JsonPrimitive
-
Returns whether the other object is equal to this.
- equals(Object) - Method in class com.google.gson.reflect.TypeToken
- excludeFieldsWithModifiers(int...) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to excludes all class fields that have the specified modifiers.
- excludeFieldsWithoutExposeAnnotation() - Method in class com.google.gson.GsonBuilder
-
Configures Gson to exclude all fields from consideration for serialization and deserialization that do not have the
Expose
annotation. - excluder() - Method in class com.google.gson.Gson
-
Deprecated.This method by accident exposes an internal Gson class; it might be removed in a future version.
- ExclusionStrategy - Interface in com.google.gson
-
A strategy (or policy) definition that is used to decide whether or not a field or class should be serialized or deserialized as part of the JSON output/input.
- Expose - Annotation Type in com.google.gson.annotations
-
An annotation that indicates this member should be exposed for JSON serialization or deserialization.
F
- 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() - Method in class com.google.gson.Gson
-
Returns the field naming strategy used by this Gson instance.
- FieldNamingStrategy - Interface in com.google.gson
-
A mechanism for providing custom field naming in 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(JsonElement, TypeToken<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, 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(JsonReader, TypeToken<T>) - Method in class com.google.gson.Gson
-
Reads the next JSON value from
reader
and converts it to an object of typetypeOfT
. - fromJson(JsonReader, Type) - Method in class com.google.gson.Gson
-
Reads the next JSON value from
reader
and converts it to an object of typetypeOfT
. - fromJson(Reader) - Method in class com.google.gson.TypeAdapter
-
Converts the JSON document in
in
to a Java object. - fromJson(Reader, TypeToken<T>) - 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(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(String) - Method in class com.google.gson.TypeAdapter
-
Converts the JSON document in
json
to a Java object. - fromJson(String, TypeToken<T>) - Method in class com.google.gson.Gson
-
This method deserializes the specified JSON into an object of the specified type.
- 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.
- fromJsonTree(JsonElement) - Method in class com.google.gson.TypeAdapter
-
Converts
jsonTree
to a Java object.
G
- 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 i-th element of the array.
- get(Class<T>) - Static method in class com.google.gson.reflect.TypeToken
-
Gets type literal for the given
Class
instance. - get(Type) - Static method in class com.google.gson.reflect.TypeToken
-
Gets type literal for the given
Type
instance. - get(String) - Method in class com.google.gson.JsonObject
-
Returns the member with the specified name.
- 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 returnsnull
. - 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
- 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
- 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
-
Convenience method to get this array as a primitive byte if it contains a single element.
- 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
-
Deprecated.This method is misleading, as it does not get this element as a char but rather as a string's first character.
- getAsCharacter() - Method in class com.google.gson.JsonElement
-
Deprecated.This method is misleading, as it does not get this element as a char but rather as a string's first character.
- getAsCharacter() - Method in class com.google.gson.JsonPrimitive
-
Deprecated.This method is misleading, as it does not get this element as a char but rather as a string's first character.
- 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
- 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
- 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
- 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
-
Convenience method to get this element as a
JsonPrimitive
. - getAsJsonPrimitive(String) - Method in class com.google.gson.JsonObject
-
Convenience method to get the specified member as a
JsonPrimitive
. - 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
- 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
- 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:
- 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 a type literal for the parameterized type represented by applying
typeArguments
torawType
. - getPath() - Method in class com.google.gson.stream.JsonReader
-
Returns a JSONPath in dot-notation to the next (or current) location in the JSON document: For JSON arrays the path points to the index of the next element (even if there are no further elements). For JSON objects the path points to the last property, or to the current property if its name has already been consumed.
- getPreviousPath() - Method in class com.google.gson.stream.JsonReader
-
Returns a JSONPath in dot-notation to the previous (or current) location in the JSON document: For JSON arrays the path points to the index of the previous element.
If no element has been consumed yet it uses the index 0 (even if there are no elements). For JSON objects the path points to the last property, or to the current property if its name has already been consumed. - 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.
H
- has(String) - Method in class com.google.gson.JsonObject
-
Convenience method to check if a member with the specified name is present in this object.
- hashCode() - Method in class com.google.gson.JsonArray
-
Returns the hash code of this array.
- hashCode() - Method in class com.google.gson.JsonNull
-
All instances of
JsonNull
have the same hash code since they are indistinguishable. - hashCode() - Method in class com.google.gson.JsonObject
-
Returns the hash code of this object.
- hashCode() - Method in class com.google.gson.JsonPrimitive
-
Returns the hash code of this object.
- hashCode() - Method in class com.google.gson.reflect.TypeToken
- hasModifier(int) - Method in class com.google.gson.FieldAttributes
-
Returns
true
if the field is defined with themodifier
. - hasNext() - Method in class com.google.gson.JsonStreamParser
-
Returns true if a
JsonElement
is available on the input for consumption - hasNext() - Method in class com.google.gson.stream.JsonReader
-
Returns true if the current array or object has another element.
- htmlSafe() - Method in class com.google.gson.Gson
-
Returns whether this Gson instance produces JSON output which is HTML-safe, that means all HTML characters are escaped.
I
- IDENTITY - com.google.gson.FieldNamingPolicy
-
Using this naming policy with Gson will ensure that the field name is unchanged.
- INDECISIVE - com.google.gson.ReflectionAccessFilter.FilterResult
-
The filter is indecisive whether reflection access should be allowed.
- 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(TypeToken<?>) - Method in class com.google.gson.reflect.TypeToken
-
Deprecated.this implementation may be inconsistent with javac for types with wildcards.
- isAssignableFrom(Class<?>) - Method in class com.google.gson.reflect.TypeToken
-
Deprecated.this implementation may be inconsistent with javac for types with wildcards.
- isAssignableFrom(Type) - Method in class com.google.gson.reflect.TypeToken
-
Deprecated.this implementation may be inconsistent with javac for types with wildcards.
- isBoolean() - Method in class com.google.gson.JsonPrimitive
-
Check whether this primitive contains a boolean value.
- isEmpty() - Method in class com.google.gson.JsonArray
-
Returns true if the array is empty.
- isEmpty() - Method in class com.google.gson.JsonObject
-
Returns true if the number of key/value pairs in the object is zero.
- 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 a check for verifying if this element is a JSON array or not.
- isJsonNull() - Method in class com.google.gson.JsonElement
-
Provides a check for verifying if this element represents a null value or not.
- isJsonObject() - Method in class com.google.gson.JsonElement
-
Provides a check for verifying if this element is a JSON object or not.
- isJsonPrimitive() - Method in class com.google.gson.JsonElement
-
Provides a 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.
J
- 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
-
Creates an empty JsonArray with the desired initial capacity.
- JsonDeserializationContext - Interface in com.google.gson
-
Context for deserialization that is passed to a custom deserializer during invocation of its
JsonDeserializer.deserialize(JsonElement, Type, JsonDeserializationContext)
method. - 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
-
Deprecated.Creating custom
JsonElement
subclasses is highly discouraged and can lead to undefined behavior.
This constructor is only kept for backward compatibility. - 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.Deprecated since Gson version 1.8, use
JsonNull.INSTANCE
instead. - JsonObject - Class in com.google.gson
-
A class representing an object type in Json.
- JsonObject() - Constructor for class com.google.gson.JsonObject
-
Creates an empty 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
-
Deprecated.No need to instantiate this class, use the static methods instead.
- 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(Character) - Constructor for class com.google.gson.JsonPrimitive
-
Create a primitive containing a character.
- 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.
- 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
-
Context for serialization that is passed to a custom serializer during invocation of its
JsonSerializer.serialize(Object, Type, JsonSerializationContext)
method. - 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(Reader) - Constructor for class com.google.gson.JsonStreamParser
- JsonStreamParser(String) - 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
.
K
- keySet() - Method in class com.google.gson.JsonObject
-
Returns a set of members key values.
L
- LAZILY_PARSED_NUMBER - com.google.gson.ToNumberPolicy
-
Using this policy will ensure that numbers will be read as a lazily parsed number backed by a string.
- LONG_OR_DOUBLE - com.google.gson.ToNumberPolicy
- LongSerializationPolicy - Enum in com.google.gson
-
Defines the expected format for a
long
orLong
type when it is serialized. - LOWER_CASE_WITH_DASHES - com.google.gson.FieldNamingPolicy
-
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_DOTS - com.google.gson.FieldNamingPolicy
-
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 dot (.).
- LOWER_CASE_WITH_UNDERSCORES - com.google.gson.FieldNamingPolicy
-
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 (_).
M
- MalformedJsonException - Exception in com.google.gson.stream
-
Thrown when a reader encounters malformed JSON.
- MalformedJsonException(String) - Constructor for exception com.google.gson.stream.MalformedJsonException
- MalformedJsonException(String, Throwable) - Constructor for exception com.google.gson.stream.MalformedJsonException
- MalformedJsonException(Throwable) - Constructor for exception com.google.gson.stream.MalformedJsonException
N
- name(String) - Method in class com.google.gson.stream.JsonWriter
-
Encodes the property name.
- NAME - com.google.gson.stream.JsonToken
-
A JSON property name.
- newBuilder() - Method in class com.google.gson.Gson
-
Returns a new GsonBuilder containing all custom factories and configuration used by the current instance.
- newJsonReader(Reader) - Method in class com.google.gson.Gson
-
Returns a new JSON reader configured for the settings on this Gson instance.
- newJsonWriter(Writer) - Method in class com.google.gson.Gson
-
Returns a new JSON writer configured for the settings on this Gson instance.
- next() - Method in class com.google.gson.JsonStreamParser
-
Returns the next available
JsonElement
on the reader. - nextBoolean() - Method in class com.google.gson.stream.JsonReader
-
Returns the
boolean
value of the next token, consuming it. - nextDouble() - Method in class com.google.gson.stream.JsonReader
-
Returns the
double
value of the next token, consuming it. - nextInt() - Method in class com.google.gson.stream.JsonReader
-
Returns the
int
value of the next token, consuming it. - nextLong() - Method in class com.google.gson.stream.JsonReader
-
Returns the
long
value of the next token, consuming it. - nextName() - Method in class com.google.gson.stream.JsonReader
-
Returns the next token, a
property name
, and consumes it. - nextNull() - Method in class com.google.gson.stream.JsonReader
-
Consumes the next token from the JSON stream and asserts that it is a literal null.
- nextString() - Method in class com.google.gson.stream.JsonReader
-
Returns the
string
value of the next token, consuming it. - NULL - com.google.gson.stream.JsonToken
-
A JSON
null
. - nullSafe() - Method in annotation type com.google.gson.annotations.JsonAdapter
-
false, to be able to handle
null
values within the adapter, default value is true. - nullSafe() - Method in class com.google.gson.TypeAdapter
-
This wrapper method is used to make a type adapter null tolerant.
- nullValue() - Method in class com.google.gson.stream.JsonWriter
-
Encodes
null
. - NUMBER - com.google.gson.stream.JsonToken
-
A JSON number represented in this API by a Java
double
,long
, orint
.
P
- parse(JsonReader) - Method in class com.google.gson.JsonParser
-
Deprecated.
- parse(Reader) - Method in class com.google.gson.JsonParser
-
Deprecated.
- parse(String) - Method in class com.google.gson.JsonParser
-
Deprecated.
- parseReader(JsonReader) - Static method in class com.google.gson.JsonParser
-
Returns the next value from the JSON stream as a parse tree.
- parseReader(Reader) - Static method in class com.google.gson.JsonParser
-
Parses the complete JSON string provided by the reader into a parse tree.
- parseString(String) - Static method in class com.google.gson.JsonParser
-
Parses the specified JSON string into a parse tree.
- peek() - Method in class com.google.gson.stream.JsonReader
-
Returns the type of the next token without consuming it.
R
- read(JsonReader) - Method in class com.google.gson.TypeAdapter
-
Reads one JSON value (an array, object, string, number, boolean or null) and converts it to a Java object.
- readNumber(JsonReader) - Method in interface com.google.gson.ToNumberStrategy
-
Reads a number from the given JSON reader.
- ReflectionAccessFilter - Interface in com.google.gson
-
Filter for determining whether reflection based serialization and deserialization is allowed for a class.
- ReflectionAccessFilter.FilterResult - Enum in com.google.gson
-
Result of a filter check.
- registerTypeAdapter(Type, Object) - Method in class com.google.gson.GsonBuilder
-
Configures Gson for custom serialization or deserialization.
- registerTypeAdapterFactory(TypeAdapterFactory) - Method in class com.google.gson.GsonBuilder
-
Register a factory for type adapters.
- registerTypeHierarchyAdapter(Class<?>, Object) - Method in class com.google.gson.GsonBuilder
-
Configures Gson for custom serialization or deserialization for an inheritance type hierarchy.
- remove() - Method in class com.google.gson.JsonStreamParser
-
This optional
Iterator
method is not relevant for stream parsing and hence is not implemented. - remove(int) - Method in class com.google.gson.JsonArray
-
Removes the element at the specified position in this array.
- remove(JsonElement) - Method in class com.google.gson.JsonArray
-
Removes the first occurrence of the specified element from this array, if it is present.
- remove(String) - Method in class com.google.gson.JsonObject
-
Removes the
property
from this object.
S
- serialize() - Method in annotation type com.google.gson.annotations.Expose
-
If
true
, the field marked with this annotation is written out in the JSON while serializing. - serialize(Long) - Method in enum com.google.gson.LongSerializationPolicy
-
Serialize this
value
using this serialization policy. - 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.
- 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
-
Returns whether this Gson instance is serializing JSON object properties with
null
values, or just omits them. - 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(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. - setDateFormat(String) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to serialize
Date
objects according to the pattern 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 fields during serialization and deserialization.
- setFieldNamingStrategy(FieldNamingStrategy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a specific naming strategy to an object's fields 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
-
Configures Gson to allow JSON data which does not strictly comply with the JSON specification.
- 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
andlong
objects. - setNumberToNumberStrategy(ToNumberStrategy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a specific number strategy during deserialization of
Number
. - setObjectToNumberStrategy(ToNumberStrategy) - Method in class com.google.gson.GsonBuilder
-
Configures Gson to apply a specific number strategy during deserialization of
Object
. - 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.
- STRING - com.google.gson.LongSerializationPolicy
-
Serializes a long value as a quoted string.
- STRING - com.google.gson.stream.JsonToken
-
A JSON string.
T
- toJson(JsonElement) - Method in class com.google.gson.Gson
-
Converts a tree of
JsonElement
s into its equivalent JSON representation. - toJson(JsonElement, JsonWriter) - Method in class com.google.gson.Gson
-
Writes the JSON for
jsonElement
towriter
. - toJson(JsonElement, Appendable) - Method in class com.google.gson.Gson
-
Writes out the equivalent JSON for a tree of
JsonElement
s. - toJson(Writer, T) - Method in class com.google.gson.TypeAdapter
-
Converts
value
to a JSON document and writes it toout
. - toJson(Object) - Method in class com.google.gson.Gson
-
This method serializes the specified object 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 and writes it to the writer.
- 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, Type, JsonWriter) - Method in class com.google.gson.Gson
-
Writes the JSON representation of
src
of typetypeOfSrc
towriter
. - 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 and writes it to the writer.
- 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. - ToNumberPolicy - Enum in com.google.gson
- ToNumberStrategy - Interface in com.google.gson
- toString() - Method in class com.google.gson.FieldAttributes
- 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.
U
- Until - Annotation Type in com.google.gson.annotations
-
An annotation that indicates the version number until a member or a type should be present.
- UPPER_CAMEL_CASE - com.google.gson.FieldNamingPolicy
-
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 - com.google.gson.FieldNamingPolicy
-
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.
- UPPER_CASE_WITH_UNDERSCORES - com.google.gson.FieldNamingPolicy
-
Using this naming policy with Gson will modify the Java Field name from its camel cased form to an upper case field name where each word is separated by an underscore (_).
V
- value() - Method in annotation type com.google.gson.annotations.JsonAdapter
- value() - Method in annotation type com.google.gson.annotations.SerializedName
- value() - Method in annotation type com.google.gson.annotations.Since
-
The value indicating a version number since this member or type has been present.
- value() - Method in annotation type com.google.gson.annotations.Until
-
The value indicating a version number until this member or type should be be included.
- value(boolean) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - value(double) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - value(float) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - value(long) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - value(Boolean) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - value(Number) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - value(String) - Method in class com.google.gson.stream.JsonWriter
-
Encodes
value
. - valueOf(String) - Static method in enum com.google.gson.FieldNamingPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.gson.LongSerializationPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.gson.ReflectionAccessFilter.FilterResult
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.gson.stream.JsonToken
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.gson.ToNumberPolicy
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.google.gson.FieldNamingPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.gson.LongSerializationPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.gson.ReflectionAccessFilter.FilterResult
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.gson.stream.JsonToken
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.gson.ToNumberPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- write(JsonWriter, T) - Method in class com.google.gson.TypeAdapter
-
Writes one JSON value (an array, object, string, number, boolean or null) for
value
.
All Classes All Packages