152 строки
10 KiB
YAML
152 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.json.models.JsonObject"
|
|
fullName: "com.azure.json.models.JsonObject"
|
|
name: "JsonObject"
|
|
nameWithType: "JsonObject"
|
|
summary: "Class representing the JSON object type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.json.models.JsonElement?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.json.models.JsonElement?alt=com.azure.json.models.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.json.models.JsonElement.isArray()?alt=com.azure.json.models.JsonElement.isArray&text=isArray\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.json.models.JsonElement.isBoolean()?alt=com.azure.json.models.JsonElement.isBoolean&text=isBoolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.json.models.JsonElement.isNull()?alt=com.azure.json.models.JsonElement.isNull&text=isNull\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.json.models.JsonElement.isNumber()?alt=com.azure.json.models.JsonElement.isNumber&text=isNumber\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.json.models.JsonElement.isObject()?alt=com.azure.json.models.JsonElement.isObject&text=isObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.json.models.JsonElement.isString()?alt=com.azure.json.models.JsonElement.isString&text=isString\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **JsonObject**</br> extends <xref href=\"com.azure.json.models.JsonElement?alt=com.azure.json.models.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.json.models.JsonObject.JsonObject()"
|
|
fullName: "com.azure.json.models.JsonObject.JsonObject()"
|
|
name: "JsonObject()"
|
|
nameWithType: "JsonObject.JsonObject()"
|
|
summary: "Default constructor."
|
|
syntax: "public JsonObject()"
|
|
desc: "Default constructor."
|
|
methods:
|
|
- uid: "com.azure.json.models.JsonObject.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.json.models.JsonObject.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "JsonObject.fromJson(JsonReader jsonReader)"
|
|
summary: "Deserializes a JSON object from a Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader to deserialize from."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static JsonObject fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while deserializing the JSON object."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Deserializes a JSON object from a JsonReader.\n\nIf the JsonReader's current token is null, it is assumed the JsonReader hasn't begun reading and <xref uid=\"com.azure.json.JsonReader.nextToken()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader#nextToken()\"></xref> will be called to begin reading.\n\nAfter ensuring the JsonReader has begun reading, if the current token is not <xref uid=\"com.azure.json.JsonToken.START_OBJECT\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonToken#START_OBJECT\"></xref>, an <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IllegalStateException\"></xref> will be thrown. Otherwise, a JSON object representing the object will be created and returned."
|
|
returns:
|
|
description: "The deserialized JSON object."
|
|
type: "<xref href=\"com.azure.json.models.JsonObject?alt=com.azure.json.models.JsonObject&text=JsonObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.getProperty(java.lang.String)"
|
|
fullName: "com.azure.json.models.JsonObject.getProperty(String key)"
|
|
name: "getProperty(String key)"
|
|
nameWithType: "JsonObject.getProperty(String key)"
|
|
summary: "Gets the Json<wbr>Element value corresponding to the specified key."
|
|
parameters:
|
|
- description: "The key of the property to get."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JsonElement getProperty(String key)"
|
|
desc: "Gets the JsonElement value corresponding to the specified key. If the key doesn't exist, null will be returned."
|
|
returns:
|
|
description: "The JsonElement value corresponding to the specified key, or null if the property doesn't exist."
|
|
type: "<xref href=\"com.azure.json.models.JsonElement?alt=com.azure.json.models.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.isObject()"
|
|
fullName: "com.azure.json.models.JsonObject.isObject()"
|
|
name: "isObject()"
|
|
nameWithType: "JsonObject.isObject()"
|
|
summary: "Indicates whether the element is an object."
|
|
overridden: "com.azure.json.models.JsonElement.isObject()"
|
|
syntax: "public boolean isObject()"
|
|
desc: "Indicates whether the element is an object."
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.removeProperty(java.lang.String)"
|
|
fullName: "com.azure.json.models.JsonObject.removeProperty(String key)"
|
|
name: "removeProperty(String key)"
|
|
nameWithType: "JsonObject.removeProperty(String key)"
|
|
summary: "Removes the Json<wbr>Element value corresponding to the specified key."
|
|
parameters:
|
|
- description: "The key of the property to remove."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JsonElement removeProperty(String key)"
|
|
desc: "Removes the JsonElement value corresponding to the specified key. If the key doesn't exist, null will be returned."
|
|
returns:
|
|
description: "The JsonElement value corresponding to the specified key, or null if the property doesn't exist."
|
|
type: "<xref href=\"com.azure.json.models.JsonElement?alt=com.azure.json.models.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.setProperty(java.lang.String,com.azure.json.models.JsonElement)"
|
|
fullName: "com.azure.json.models.JsonObject.setProperty(String key, JsonElement element)"
|
|
name: "setProperty(String key, JsonElement element)"
|
|
nameWithType: "JsonObject.setProperty(String key, JsonElement element)"
|
|
summary: "Sets the Json<wbr>Element value corresponding to the specified key."
|
|
parameters:
|
|
- description: "The key of the property to set."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The JsonElement value to set the property to."
|
|
name: "element"
|
|
type: "<xref href=\"com.azure.json.models.JsonElement?alt=com.azure.json.models.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonObject setProperty(String key, JsonElement element)"
|
|
desc: "Sets the JsonElement value corresponding to the specified key. If the key already exists, the value will be overwritten."
|
|
returns:
|
|
description: "The updated JsonObject object."
|
|
type: "<xref href=\"com.azure.json.models.JsonObject?alt=com.azure.json.models.JsonObject&text=JsonObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.size()"
|
|
fullName: "com.azure.json.models.JsonObject.size()"
|
|
name: "size()"
|
|
nameWithType: "JsonObject.size()"
|
|
summary: "The number of properties in the JSON object."
|
|
syntax: "public int size()"
|
|
desc: "The number of properties in the JSON object."
|
|
returns:
|
|
description: "The number of properties in the JSON object."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.json.models.JsonObject.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "JsonObject.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonObject.toJsonString()"
|
|
fullName: "com.azure.json.models.JsonObject.toJsonString()"
|
|
name: "toJsonString()"
|
|
nameWithType: "JsonObject.toJsonString()"
|
|
syntax: "public String toJsonString()"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "Class representing the JSON object type."
|
|
metadata: {}
|
|
package: "com.azure.json.models"
|
|
artifact: com.azure:azure-json:1.3.0
|