Package com.azure.json.gson

Class GsonJsonReader

java.lang.Object

com.azure.json.JsonReader

com.azure.json.gson.GsonJsonReader

All Implemented Interfaces:

Closeable, AutoCloseable

public final class GsonJsonReader
extends JsonReader

GSON-based implementation of JsonReader

Method Summary

Modifier and Type	Method	Description
JsonReader	bufferObject()	Reads and returns the current JSON structure the JsonReader is pointing to.
void	close()
JsonToken	currentToken()	Gets the JsonToken that the reader currently points.
static JsonReader	fromBytes(byte[] json)	Constructs an instance of GsonJsonReader from a byte[].
static JsonReader	fromStream(InputStream json)	Constructs an instance of GsonJsonReader from an InputStream.
static JsonReader	fromString(String json)	Constructs an instance of GsonJsonReader from a String.
byte[]	getBinaryValue()	Gets the binary value if the reader is currently pointing to a JsonToken.STRING token.
boolean	getBooleanValue()	Gets the boolean value if the reader is currently pointing to a JsonToken.BOOLEAN token.
double	getDoubleValue()	Gets the double value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.
String	getFieldName()	Gets the field name if the reader is currently pointing to a JsonToken.FIELD_NAME.
float	getFloatValue()	Gets the float value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.
int	getIntValue()	Gets the int value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.
long	getLongValue()	Gets the long value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.
String	getStringValue()	Gets the String value if the reader is currently pointing to a JsonToken.BOOLEAN, JsonToken.NULL, JsonToken.NUMBER, or JsonToken.STRING.
JsonToken	nextToken()	Iterates to and returns the next JsonToken in the JSON encoded value.
JsonReader	reset()	Creates a new JsonReader reset to the beginning of the JSON stream.
boolean	resetSupported()	Indicates whether the JsonReader supports resetting.
void	skipChildren()	Recursively skips the JSON token sub-stream if the current token is either JsonToken.START_ARRAY or JsonToken.START_OBJECT.

Methods inherited from class com.azure.json.JsonReader

getBooleanNullableValue, getDoubleNullableValue, getFloatNullableValue, getIntegerNullableValue, getLongNullableValue, getNullableValue, getTextValue, isEndArrayOrObject, isStartArrayOrObject, readArray, readChildren, readChildren, readMap, readObject, readUntyped

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fromBytes

public static JsonReader fromBytes(byte[] json)

Constructs an instance of GsonJsonReader from a byte[].

Parameters:

json - JSON byte[].

Returns:

An instance of GsonJsonReader.

fromString

public static JsonReader fromString(String json)

Constructs an instance of GsonJsonReader from a String.

Parameters:

json - JSON String.

Returns:

An instance of GsonJsonReader.

fromStream

public static JsonReader fromStream(InputStream json)

Constructs an instance of GsonJsonReader from an InputStream.

Parameters:

json - JSON InputStream.

Returns:

An instance of GsonJsonReader.

currentToken

public JsonToken currentToken()

Description copied from class: JsonReader

Gets the JsonToken that the reader currently points.

Returns null if the reader isn't pointing to a token. This happens if the reader hasn't begun to read the JSON value or if reading of the JSON value has completed.

Specified by:

currentToken in class JsonReader

Returns:

The JsonToken that the reader currently points, or null if the reader isn't pointing to a token.

nextToken

public JsonToken nextToken()

Description copied from class: JsonReader

Iterates to and returns the next JsonToken in the JSON encoded value.

Returns null if iterating to the next token completes reading of the JSON encoded value.

Specified by:

nextToken in class JsonReader

Returns:

The next JsonToken in the JSON encoded value, or null if reading completes.

getBinaryValue

public byte[] getBinaryValue()

Description copied from class: JsonReader

Gets the binary value if the reader is currently pointing to a JsonToken.STRING token.

This returns the equivalent of Base64.getDecoder() Base64.Decoder.decode(String).

If the reader is pointing to a JsonToken.NULL null will be returned. If the reader is pointing to any other token type an IllegalStateException will be thrown.

Specified by:

getBinaryValue in class JsonReader

Returns:

The binary value based on whether the current token is JsonToken.STRING or JsonToken.NULL.

getBooleanValue

public boolean getBooleanValue()

Description copied from class: JsonReader

Gets the boolean value if the reader is currently pointing to a JsonToken.BOOLEAN token.

If the reader is pointing to any other token type an IllegalStateException will be thrown.

If Boolean should be read use JsonReader.getBooleanNullableValue().

Specified by:

getBooleanValue in class JsonReader

Returns:

The boolean value based on the JsonToken.BOOLEAN.

getDoubleValue

public double getDoubleValue()

Description copied from class: JsonReader

Gets the double value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.

JsonToken.STRING will throw a NumberFormatException if the underlying string value cannot be converted to a double.

All other JsonToken types will throw an IllegalStateException.

If Double should be read use JsonReader.getDoubleNullableValue().

Specified by:

getDoubleValue in class JsonReader

Returns:

The double value based on the current token.

getFloatValue

public float getFloatValue()

Description copied from class: JsonReader

Gets the float value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.

JsonToken.STRING will throw a NumberFormatException if the underlying string value cannot be converted to a float.

All other JsonToken types will throw an IllegalStateException.

If Float should be read use JsonReader.getFloatNullableValue().

Specified by:

getFloatValue in class JsonReader

Returns:

The float value based on the current token.

getIntValue

public int getIntValue()

Description copied from class: JsonReader

Gets the int value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.

JsonToken.STRING will throw a NumberFormatException if the underlying string value cannot be converted to an int.

All other JsonToken types will throw an IllegalStateException.

If Integer should be read use JsonReader.getIntegerNullableValue()

Specified by:

getIntValue in class JsonReader

Returns:

The int value based on the current token.

getLongValue

public long getLongValue()

Description copied from class: JsonReader

Gets the long value if the reader is currently pointing to a JsonToken.NUMBER or JsonToken.STRING.

JsonToken.STRING will throw a NumberFormatException if the underlying string value cannot be converted to a long.

All other JsonToken types will throw an IllegalStateException.

If Long should be read use JsonReader.getLongNullableValue().

Specified by:

getLongValue in class JsonReader

Returns:

The long value based on the current token.

getStringValue

public String getStringValue()

Description copied from class: JsonReader

Gets the String value if the reader is currently pointing to a JsonToken.BOOLEAN, JsonToken.NULL, JsonToken.NUMBER, or JsonToken.STRING.

If the current token is a JsonToken.BOOLEAN, or JsonToken.NUMBER the String representation of the value will be returned. If the current token is JsonToken.NULL null will be returned.

All other JsonToken types will throw an IllegalStateException.

Specified by:

getStringValue in class JsonReader

Returns:

The String value based on the current token.

getFieldName

public String getFieldName()

Description copied from class: JsonReader

Gets the field name if the reader is currently pointing to a JsonToken.FIELD_NAME.

All other JsonToken types will throw an IllegalStateException.

Specified by:

getFieldName in class JsonReader

Returns:

The field name based on the current token.

skipChildren

public void skipChildren()

Description copied from class: JsonReader

Recursively skips the JSON token sub-stream if the current token is either JsonToken.START_ARRAY or JsonToken.START_OBJECT.

If the current token isn't the beginning of an array or object this method is a no-op.

Specified by:

skipChildren in class JsonReader

bufferObject

public JsonReader bufferObject()

Description copied from class: JsonReader

Reads and returns the current JSON structure the JsonReader is pointing to. This will mutate the current location of this JsonReader.

If the JsonReader.currentToken() isn't JsonToken.START_OBJECT or JsonToken.FIELD_NAME an IllegalStateException will be thrown.

The returned JsonReader is able to be JsonReader.reset() to replay the underlying JSON stream.

Specified by:

bufferObject in class JsonReader

Returns:

The buffered JSON object the JsonReader was pointing to.

resetSupported

public boolean resetSupported()

Description copied from class: JsonReader

Indicates whether the JsonReader supports resetting.

Specified by:

resetSupported in class JsonReader

Returns:

Whether JsonReader.reset() is supported.

reset

public JsonReader reset()

Description copied from class: JsonReader

Creates a new JsonReader reset to the beginning of the JSON stream.

Use JsonReader.resetSupported() to determine whether the JsonReader can be reset. If resetting is called and it isn't supported an IllegalStateException will be thrown.

Specified by:

reset in class JsonReader

Returns:

A new JsonReader reset to the beginning of the JSON stream.

close

public void close()
           throws IOException

Throws:

IOException