Class JsonObject

A class representing an object type in Json. An object consists of name-value pairs where names are strings, and values are any other type of JsonElement. This allows for a creating a tree of JsonElements. The member elements of this object are maintained in order they were added.

See com.google.gson.JsonObject for full documentation

Hierarchy

JsonElement
- JsonObject

Constructors

constructor

new JsonObject(): JsonObject
Returns JsonObject
Inherited from JsonElement.constructor

Methods

add

add(property, value): void
Adds a member, which is a name-value pair, to self.
Parameters
- property: string
- value: string | number | boolean | JsonElement
Returns void
- Defined in Java.d.ts:383

deepCopy

deepCopy(): JsonElement
Returns a deep copy of this element.

Returns JsonElement
Inherited from JsonElement.deepCopy
- Defined in Java.d.ts:237

entrySet

entrySet(): Set<Map<string, JsonElement>>
Returns a set of members of this object.

Returns Set<Map<string, JsonElement>>
- Defined in Java.d.ts:387

get

get(memberName): JsonElement
Returns the member with the specified name.
Parameters
- memberName: string
Returns JsonElement
- Defined in Java.d.ts:391

getAsBigDecimal

getAsBigDecimal(): number
convenience method to get this element as a BigDecimal.

Returns number
Inherited from JsonElement.getAsBigDecimal
- Defined in Java.d.ts:241

getAsBigInteger

getAsBigInteger(): number
convenience method to get this element as a BigInteger.

Returns number
Inherited from JsonElement.getAsBigInteger
- Defined in Java.d.ts:245

getAsBoolean

getAsBoolean(): boolean
convenience method to get this element as a boolean value.

Returns boolean
Inherited from JsonElement.getAsBoolean
- Defined in Java.d.ts:249

getAsCharacter

getAsCharacter(): string
convenience method to get this element as a primitive character value.

Returns string
Inherited from JsonElement.getAsCharacter
- Defined in Java.d.ts:258

getAsDouble

getAsDouble(): number
convenience method to get this element as a primitive double value.

Returns number
Inherited from JsonElement.getAsDouble
- Defined in Java.d.ts:262

getAsFloat

getAsFloat(): number
convenience method to get this element as a primitive float value.

Returns number
Inherited from JsonElement.getAsFloat
- Defined in Java.d.ts:266

getAsInt

getAsInt(): number
convenience method to get this element as a primitive integer value.

Returns number
Inherited from JsonElement.getAsInt
- Defined in Java.d.ts:270

getAsJsonArray

getAsJsonArray(): JsonArray
convenience method to get this element as a JsonArray.

Returns JsonArray
Inherited from JsonElement.getAsJsonArray
- Defined in Java.d.ts:274

getAsJsonNull

getAsJsonNull(): JsonNull
convenience method to get this element as a JsonNull.

Returns JsonNull
Inherited from JsonElement.getAsJsonNull
- Defined in Java.d.ts:278

getAsJsonObject

getAsJsonObject(): JsonObject
convenience method to get this element as a JsonObject.

Returns JsonObject
Inherited from JsonElement.getAsJsonObject
- Defined in Java.d.ts:282

getAsJsonPrimitive

getAsJsonPrimitive(): JsonPrimitive
convenience method to get this element as a JsonPrimitive.

Returns JsonPrimitive
Inherited from JsonElement.getAsJsonPrimitive
- Defined in Java.d.ts:286

getAsLong

getAsLong(): number
convenience method to get this element as a primitive long value.

Returns number
Inherited from JsonElement.getAsLong
- Defined in Java.d.ts:290

getAsNumber

getAsNumber(): number
convenience method to get this element as a Number.

Returns number
Inherited from JsonElement.getAsNumber
- Defined in Java.d.ts:294

getAsShort

getAsShort(): number
convenience method to get this element as a primitive short value.

Returns number
Inherited from JsonElement.getAsShort
- Defined in Java.d.ts:298

getAsString

getAsString(): string
convenience method to get this element as a string value.

Returns string
Inherited from JsonElement.getAsString
- Defined in Java.d.ts:302

has

has(memberName): boolean
Convenience method to check if a member with the specified name is present in this object.
Parameters
- memberName: string
Returns boolean
- Defined in Java.d.ts:395

isJsonArray

isJsonArray(): boolean
provides check for verifying if this element is an array or not.

Returns boolean
Inherited from JsonElement.isJsonArray
- Defined in Java.d.ts:306

isJsonNull

isJsonNull(): boolean
provides check for verifying if this element represents a null value or not.

Returns boolean
Inherited from JsonElement.isJsonNull
- Defined in Java.d.ts:310

isJsonObject

isJsonObject(): boolean
provides check for verifying if this element is a Json object or not.

Returns boolean
Inherited from JsonElement.isJsonObject
- Defined in Java.d.ts:314

isJsonPrimitive

isJsonPrimitive(): boolean
provides check for verifying if this element is a primitive or not.

Returns boolean
Inherited from JsonElement.isJsonPrimitive
- Defined in Java.d.ts:318

keySet

keySet(): Set<string>
Returns a set of members key values.

Returns Set<string>
- Defined in Java.d.ts:399

remove

remove(property): JsonElement
Removes the property from this JsonObject.
Parameters
- property: string
Returns JsonElement
- Defined in Java.d.ts:403

size

size(): number
Returns the number of key/value pairs in the object.

Returns number
- Defined in Java.d.ts:407

Generated using TypeDoc