152 строки
14 KiB
YAML
152 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject"
|
|
name: "JacksonJsonObject"
|
|
nameWithType: "JacksonJsonObject"
|
|
summary: "Implementation of <xref uid=\"com.azure.json.models.JsonElement\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonElement\"></xref> which is backed by Jackson's <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref>."
|
|
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 **JacksonJsonObject**</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.core.serializer.json.jackson.models.JacksonJsonObject.JacksonJsonObject()"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.JacksonJsonObject()"
|
|
name: "JacksonJsonObject()"
|
|
nameWithType: "JacksonJsonObject.JacksonJsonObject()"
|
|
summary: "Creates a new <xref uid=\"com.azure.core.serializer.json.jackson.models.JacksonJsonObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JacksonJsonObject\"></xref> using the default <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonNodeFactory#instance\"></xref> <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref>."
|
|
syntax: "public JacksonJsonObject()"
|
|
desc: "Creates a new <xref uid=\"com.azure.core.serializer.json.jackson.models.JacksonJsonObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JacksonJsonObject\"></xref> using the default <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonNodeFactory#instance\"></xref> <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref>."
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.JacksonJsonObject(com.fasterxml.jackson.databind.node.ObjectNode)"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.JacksonJsonObject(ObjectNode object)"
|
|
name: "JacksonJsonObject(ObjectNode object)"
|
|
nameWithType: "JacksonJsonObject.JacksonJsonObject(ObjectNode object)"
|
|
summary: "Creates a new <xref uid=\"com.azure.core.serializer.json.jackson.models.JacksonJsonObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JacksonJsonObject\"></xref> using the provided <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref>."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref> to use as the backing object."
|
|
name: "object"
|
|
type: "<xref href=\"com.fasterxml.jackson.databind.node.ObjectNode?alt=com.fasterxml.jackson.databind.node.ObjectNode&text=ObjectNode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JacksonJsonObject(ObjectNode object)"
|
|
desc: "Creates a new <xref uid=\"com.azure.core.serializer.json.jackson.models.JacksonJsonObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JacksonJsonObject\"></xref> using the provided <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "JacksonJsonObject.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 JacksonJsonObject 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=\"\" 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.core.serializer.json.jackson.models.JacksonJsonObject?alt=com.azure.core.serializer.json.jackson.models.JacksonJsonObject&text=JacksonJsonObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.getProperty(java.lang.String)"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.getProperty(String key)"
|
|
name: "getProperty(String key)"
|
|
nameWithType: "JacksonJsonObject.getProperty(String key)"
|
|
summary: "Gets the Json<wbr>Node 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 JsonNode getProperty(String key)"
|
|
desc: "Gets the JsonNode value corresponding to the specified key. If the key doesn't exist, null will be returned."
|
|
returns:
|
|
description: "The JsonNode value corresponding to the specified key, or null if the property doesn't exist."
|
|
type: "<xref href=\"com.fasterxml.jackson.databind.JsonNode?alt=com.fasterxml.jackson.databind.JsonNode&text=JsonNode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.isObject()"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.isObject()"
|
|
name: "isObject()"
|
|
nameWithType: "JacksonJsonObject.isObject()"
|
|
overridden: "com.azure.json.models.JsonElement.isObject()"
|
|
syntax: "public boolean isObject()"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.removeProperty(java.lang.String)"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.removeProperty(String key)"
|
|
name: "removeProperty(String key)"
|
|
nameWithType: "JacksonJsonObject.removeProperty(String key)"
|
|
summary: "Removes the Json<wbr>Node 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 JsonNode removeProperty(String key)"
|
|
desc: "Removes the JsonNode value corresponding to the specified key. If the key doesn't exist, null will be returned."
|
|
returns:
|
|
description: "The JsonNode value corresponding to the specified key, or null if the property doesn't exist."
|
|
type: "<xref href=\"com.fasterxml.jackson.databind.JsonNode?alt=com.fasterxml.jackson.databind.JsonNode&text=JsonNode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.setProperty(java.lang.String,com.fasterxml.jackson.databind.JsonNode)"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.setProperty(String key, JsonNode node)"
|
|
name: "setProperty(String key, JsonNode node)"
|
|
nameWithType: "JacksonJsonObject.setProperty(String key, JsonNode node)"
|
|
summary: "Sets the Json<wbr>Node 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 JsonNode value to set the property to."
|
|
name: "node"
|
|
type: "<xref href=\"com.fasterxml.jackson.databind.JsonNode?alt=com.fasterxml.jackson.databind.JsonNode&text=JsonNode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JacksonJsonObject setProperty(String key, JsonNode node)"
|
|
desc: "Sets the JsonNode value corresponding to the specified key. If the key already exists, the value will be overwritten."
|
|
returns:
|
|
description: "The updated JacksonJsonObject object."
|
|
type: "<xref href=\"com.azure.core.serializer.json.jackson.models.JacksonJsonObject?alt=com.azure.core.serializer.json.jackson.models.JacksonJsonObject&text=JacksonJsonObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.size()"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.size()"
|
|
name: "size()"
|
|
nameWithType: "JacksonJsonObject.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.core.serializer.json.jackson.models.JacksonJsonObject.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.core.serializer.json.jackson.models.JacksonJsonObject.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "JacksonJsonObject.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\" />"
|
|
type: "class"
|
|
desc: "Implementation of <xref uid=\"com.azure.json.models.JsonElement\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonElement\"></xref> which is backed by Jackson's <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref>.\n\nThis allows for using Jackson's <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref> in places where <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonObject\"></xref> is required, meaning the Jackson <xref uid=\"com.fasterxml.jackson.databind.node.ObjectNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectNode\"></xref> doesn't need to be converted to azure-json's <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonObject\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.core.serializer.json.jackson.models"
|
|
artifact: com.azure:azure-core-serializer-json-jackson:1.5.3
|