Package com.azure.json

Class JsonWriteContext

java.lang.Object

com.azure.json.JsonWriteContext

public final class JsonWriteContext
extends Object

Context of JSON handling.

Writing context is immutable, any calls to updateContext(JsonToken) will result in either a previous context being returned or the creation of a new context.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonWriteContext	COMPLETED	Final writing context.
static final JsonWriteContext	ROOT	Initial writing context.

Method Summary

Modifier and Type	Method	Description
JsonWriteContext	getParent()	Gets the parent JsonWriteContext.
JsonWriteState	getWriteState()	Gets the JsonWriteState associated to the writing context.
JsonWriteContext	updateContext(JsonToken token)	Updates the context based on the JsonToken that was written.
void	validateToken(JsonToken token)	Determines whether the JsonToken is allowed to be written based on the JsonWriteState.

Methods inherited from class java.lang.Object

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

Field Details

ROOT

public static final JsonWriteContext ROOT

Initial writing context.

COMPLETED

public static final JsonWriteContext COMPLETED

Final writing context.

Method Details

getParent

public JsonWriteContext getParent()

Gets the parent JsonWriteContext.

ROOT and COMPLETED are terminal writing contexts and don't have parent contexts. These are the only writing contexts that will return null.

Returns:

The parent writing context.

getWriteState

public JsonWriteState getWriteState()

Gets the JsonWriteState associated to the writing context.

Returns:

The JsonWriteState associated to the writing context.

validateToken

public void validateToken(JsonToken token)

Determines whether the JsonToken is allowed to be written based on the JsonWriteState.

The following is the allowed JsonTokens based on the JsonWriteState.

• JsonWriteState.ROOT - JsonToken.START_OBJECT, JsonToken.START_ARRAY, JsonToken.BOOLEAN, JsonToken.NULL, JsonToken.NUMBER, JsonToken.STRING
• JsonWriteState.OBJECT - JsonToken.END_OBJECT, JsonToken.FIELD_NAME
• JsonWriteState.ARRAY - JsonToken.START_OBJECT, JsonToken.START_ARRAY, JsonToken.END_ARRAY, JsonToken.BOOLEAN, JsonToken.NULL, JsonToken.NUMBER, JsonToken.STRING
• JsonWriteState.FIELD - JsonToken.START_OBJECT, JsonToken.START_ARRAY, JsonToken.BOOLEAN, JsonToken.NULL, JsonToken.NUMBER, JsonToken.STRING
• JsonWriteState.COMPLETED - none

Any token that isn't allowed based on the context will result in an IllegalStateException.

Field and value APIs in JsonWriter, such as JsonWriter.writeStringField(String, String), will validate with JsonToken.FIELD_NAME as they're self-closing operations.

Parameters:

token - The JsonToken that is being validated for being writable in the current state.

Throws:

IllegalStateException - If the JsonToken is invalid based on the JsonWriteState.

updateContext

public JsonWriteContext updateContext(JsonToken token)

Updates the context based on the JsonToken that was written.

Tokens JsonToken.BOOLEAN, JsonToken.NULL, JsonToken.NUMBER, and JsonToken.STRING can mutate the current state in three different ways. If the current context is ROOT then COMPLETED is the updated context as the JSON stream has completed writing. If the current context is JsonWriteState.ARRAY then this context is returned without mutation as writing an element to an array doesn't complete the array. Otherwise, the parent context is returned as the only other legal context is JsonWriteState.FIELD and writing a value completes the field.

Tokens JsonToken.END_OBJECT and JsonToken.END_ARRAY complete the current context and prepare set the parent context for return. If the parent context is ROOT then COMPLETED is the updated context as the JSON stream has completed writing. Otherwise, if the parent context is JsonWriteState.FIELD that will be completed as well as the field has completed writing.

Tokens JsonToken.START_OBJECT, JsonToken.START_ARRAY, and JsonToken.FIELD_NAME create a child context where the current context becomes the parent context.

Field and value APIs in JsonWriter, such as JsonWriter.writeStringField(String, String), are self-closing operations that will maintain the current context.

Parameters:

token - The JsonToken triggering the update.

Returns:

The updated writing context.