JsonBoolean Class

Package:

com.azure.json.models

Maven Artifact:

com.azure:azure-json:1.5.1

• java.lang.Object
• • com.azure.json.models.JsonElement
  • • com.azure.json.models.JsonBoolean

public final class JsonBoolean
extends JsonElement

Model representing a JSON boolean value.

Method Summary

Modifier and Type	Method and Description
static JsonBoolean	fromJson(JsonReader jsonReader) Deserializes a JSON boolean from a JsonReader.
static JsonBoolean	getInstance(boolean value) Gets the instance of JsonBoolean for the specified boolean value.
boolean	getValue() Returns boolean value from a JsonBoolean object.
boolean	isBoolean() Identifies if an object is of type JsonBoolean.
JsonWriter	toJson(JsonWriter jsonWriter)
String	toJsonString()

Methods inherited from JsonElement

asArray asBoolean asNull asNumber asObject asString isArray isBoolean isNull isNumber isObject isString

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static JsonBoolean fromJson(JsonReader jsonReader)

Deserializes a JSON boolean from a JsonReader.

If the JsonReader's current token is null, it is assumed the JsonReader hasn't begun reading and nextToken() will be called to begin reading.

After ensuring the JsonReader has begun reading, if the current token is not BOOLEAN, an IllegalStateException will be thrown. Otherwise, getInstance(boolean value) will be called to return the deserialized JSON boolean.

Parameters:

jsonReader - The JsonReader to deserialize from.

Returns:

The deserialized JSON boolean.

Throws:

IOException

- If an error occurs while deserializing the JSON boolean.

getInstance

public static JsonBoolean getInstance(boolean value)

Gets the instance of JsonBoolean for the specified boolean value.

Parameters:

value - The boolean value for which to obtain the JsonBoolean instance.

Returns:

The instance of JsonBoolean representing the specified boolean value.

getValue

public boolean getValue()

Returns boolean value from a JsonBoolean object.

Returns:

The boolean value.

isBoolean

public boolean isBoolean()

Identifies if an object is of type JsonBoolean.

Overrides:

JsonBoolean.isBoolean()

Returns:

boolean of whether this JsonElement object is of type JsonBoolean.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

toJsonString

public String toJsonString()

Throws:

IOException