azure-docs-sdk-java/docs-ref-autogen/com.azure.json.models.JsonN...

112 строки
8.7 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.json.models.JsonNumber"
fullName: "com.azure.json.models.JsonNumber"
name: "JsonNumber"
nameWithType: "JsonNumber"
summary: "Class representing the JSON number 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 **JsonNumber**</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.JsonNumber.JsonNumber(java.lang.Number)"
fullName: "com.azure.json.models.JsonNumber.JsonNumber(Number value)"
name: "JsonNumber(Number value)"
nameWithType: "JsonNumber.JsonNumber(Number value)"
summary: "Creates a Json<wbr>Number representing the specified number."
parameters:
- description: "The number value the JsonNumber will represent."
name: "value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html\">Number</a>"
syntax: "public JsonNumber(Number value)"
desc: "Creates a JsonNumber representing the specified number."
methods:
- uid: "com.azure.json.models.JsonNumber.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.json.models.JsonNumber.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "JsonNumber.fromJson(JsonReader jsonReader)"
summary: "Deserializes a JSON number 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 JsonNumber fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while deserializing the JSON number."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Deserializes a JSON number 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.NUMBER\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonToken#NUMBER\"></xref>, an <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IllegalStateException\"></xref> will be thrown. Otherwise, a JSON number representing the numeric value will be created and returned.\n\nThe <xref uid=\"com.azure.json.models.JsonNumber\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonNumber\"></xref> returned will have a <xref uid=\"com.azure.json.models.JsonNumber.getValue()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonNumber#getValue()\"></xref> that is the smallest type that can represent the numeric value. Numeric types used are <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Integer\"></xref>, <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Long\"></xref>, <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BigInteger\"></xref>, <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Float\"></xref>, <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Double\"></xref>, and <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BigDecimal\"></xref>."
returns:
description: "The deserialized JSON number."
type: "<xref href=\"com.azure.json.models.JsonNumber?alt=com.azure.json.models.JsonNumber&text=JsonNumber\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.json.models.JsonNumber.getValue()"
fullName: "com.azure.json.models.JsonNumber.getValue()"
name: "getValue()"
nameWithType: "JsonNumber.getValue()"
summary: "Returns the Number value from a Json<wbr>Number object."
syntax: "public Number getValue()"
desc: "Returns the Number value from a JsonNumber object."
returns:
description: "The Number value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html\">Number</a>"
- uid: "com.azure.json.models.JsonNumber.isNumber()"
fullName: "com.azure.json.models.JsonNumber.isNumber()"
name: "isNumber()"
nameWithType: "JsonNumber.isNumber()"
summary: "Whether the Json<wbr>Element is a Json<wbr>Number."
overridden: "com.azure.json.models.JsonElement.isNumber()"
syntax: "public boolean isNumber()"
desc: "Whether the JsonElement is a JsonNumber."
returns:
description: "boolean of whether this JsonElement object is of type JsonNumber."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.json.models.JsonNumber.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.json.models.JsonNumber.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "JsonNumber.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.JsonNumber.toJsonString()"
fullName: "com.azure.json.models.JsonNumber.toJsonString()"
name: "toJsonString()"
nameWithType: "JsonNumber.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 number type"
metadata: {}
package: "com.azure.json.models"
artifact: com.azure:azure-json:1.3.0