112 строки
7.9 KiB
YAML
112 строки
7.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.json.models.JsonString"
|
|
fullName: "com.azure.json.models.JsonString"
|
|
name: "JsonString"
|
|
nameWithType: "JsonString"
|
|
summary: "Class representing the JSON string 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 **JsonString**</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.JsonString.JsonString(java.lang.String)"
|
|
fullName: "com.azure.json.models.JsonString.JsonString(String value)"
|
|
name: "JsonString(String value)"
|
|
nameWithType: "JsonString.JsonString(String value)"
|
|
summary: "Constructor used to explicitly set the string value of the Json<wbr>String object."
|
|
parameters:
|
|
- description: "specifies the text string this JsonString object represents"
|
|
name: "value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JsonString(String value)"
|
|
desc: "Constructor used to explicitly set the string value of the JsonString object. Adds the starting and ending double quotation marks."
|
|
methods:
|
|
- uid: "com.azure.json.models.JsonString.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.json.models.JsonString.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "JsonString.fromJson(JsonReader jsonReader)"
|
|
summary: "Deserializes a JSON string 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 JsonString fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while deserializing the JSON string."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Deserializes a JSON string 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.STRING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonToken#STRING\"></xref>, an <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IllegalStateException\"></xref> will be thrown. Otherwise, a JSON string representing the string value will be created and returned."
|
|
returns:
|
|
description: "The deserialized JSON string."
|
|
type: "<xref href=\"com.azure.json.models.JsonString?alt=com.azure.json.models.JsonString&text=JsonString\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonString.getValue()"
|
|
fullName: "com.azure.json.models.JsonString.getValue()"
|
|
name: "getValue()"
|
|
nameWithType: "JsonString.getValue()"
|
|
summary: "Gets the string value of this Json<wbr>String object."
|
|
syntax: "public String getValue()"
|
|
desc: "Gets the string value of this JsonString object."
|
|
returns:
|
|
description: "the string value of this JsonString object"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.json.models.JsonString.isString()"
|
|
fullName: "com.azure.json.models.JsonString.isString()"
|
|
name: "isString()"
|
|
nameWithType: "JsonString.isString()"
|
|
summary: "Indicates whether the element is a string."
|
|
overridden: "com.azure.json.models.JsonElement.isString()"
|
|
syntax: "public boolean isString()"
|
|
desc: "Indicates whether the element is a string."
|
|
returns:
|
|
description: "boolean of whether this JsonElement object is of type JsonString."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.json.models.JsonString.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.json.models.JsonString.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "JsonString.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.JsonString.toJsonString()"
|
|
fullName: "com.azure.json.models.JsonString.toJsonString()"
|
|
name: "toJsonString()"
|
|
nameWithType: "JsonString.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 string type"
|
|
metadata: {}
|
|
package: "com.azure.json.models"
|
|
artifact: com.azure:azure-json:1.3.0
|