com.mojang.serialization

Class JsonOps

java.lang.Object

com.mojang.serialization.JsonOps

All Implemented Interfaces:

DynamicOps<JsonElement>

public class JsonOps
extends Object
implements DynamicOps<JsonElement>

A DynamicOps adapter for JSON. Instances of this class serialize data to and from JSON.

Field Summary

Fields

Modifier and Type	Field and Description
static JsonOps	COMPRESSED The singleton JsonOps instance for compressed JSON serialization.
static JsonOps	INSTANCE The singleton JsonOps instance for uncompressed JSON serialization.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonOps(boolean compressed) Constructs a JsonOps with the given settings.

Method Summary

Modifier and Type	Method and Description
boolean	compressMaps() Whether the caller should serialize maps using a compressed representation.
<U> U	convertTo(DynamicOps<U> outOps, JsonElement input) Converts a value of the serialization type to an equivalent value of another serialization type.
JsonElement	createBoolean(boolean value) Serializes a boolean value to the serialized type.
JsonElement	createList(Stream<JsonElement> input) Serializes a list of values, in the form of a Stream to the serialized type.
JsonElement	createMap(Stream<(JsonElement,JsonElement)> map) Serializes a Stream of entries to a map serialized value.
JsonElement	createNumeric(Number i) Serializes a Number value to the serialized type.
JsonElement	createString(String value) Serializes a String value to the serialized type.
JsonElement	empty() Returns the empty value of the serialization type.
DataResult<Boolean>	getBooleanValue(JsonElement input) Attempts to parse or coerce a boolean value from the input.
DataResult<((JsonElement) -> void) -> void>	getList(JsonElement input) Extracts a Consumer from the given value that iterates over the elements of the serialized list.
DataResult<MapLike<JsonElement>>	getMap(JsonElement input) Extracts the entries in the given value, returning them in a MapLike object.
DataResult<((JsonElement,JsonElement) -> void) -> void>	getMapEntries(JsonElement input) Extracts a Consumer from the given value that iterates over the entries of the serialized map.
DataResult<Stream<(JsonElement,JsonElement)>>	getMapValues(JsonElement input) Extracts a Stream of map entries from the given serialized value.
DataResult<Number>	getNumberValue(JsonElement input) Attempts to parse or coerce a Number value from the input.
DataResult<Stream<JsonElement>>	getStream(JsonElement input) Extracts a Stream of list elements from the given serialized value.
DataResult<String>	getStringValue(JsonElement input) Attempts to parse or coerce a String value from the input.
ListBuilder<JsonElement>	listBuilder() Returns a new ListBuilder for creating lists of the serialized type.
RecordBuilder<JsonElement>	mapBuilder() Returns a new RecordBuilder for creating maps of the serialized type.
DataResult<JsonElement>	mergeToList(JsonElement list, JsonElement value) Creates a new serialized list from the given serialized list with the given value appended.
DataResult<JsonElement>	mergeToList(JsonElement list, List<JsonElement> values) Creates a new serialized list from the given serialized list with the values from the given List appended.
DataResult<JsonElement>	mergeToMap(JsonElement map, JsonElement key, JsonElement value) Creates a new serialized map from the given serialized map with the given key-value mapping added.
DataResult<JsonElement>	mergeToMap(JsonElement map, MapLike<JsonElement> values) Creates a new serialized map from the given serialized map with the entries in the given MapLike added.
JsonElement	remove(JsonElement input, String key) Returns an equivalent value with the entry associated with the given key removed.
String	toString() Returns a String identifying this DynamicOps as a JsonOps.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mojang.serialization.DynamicOps

convertList, convertMap, createByte, createByteList, createDouble, createFloat, createInt, createIntList, createLong, createLongList, createMap, createShort, emptyList, emptyMap, get, getByteBuffer, getGeneric, getIntStream, getLongStream, getNumberValue, mergeToMap, mergeToPrimitive, set, update, updateGeneric, withDecoder, withEncoder, withParser

Field Detail

INSTANCE

public static final JsonOps INSTANCE

The singleton JsonOps instance for uncompressed JSON serialization.

See Also:

compressMaps()

COMPRESSED

public static final JsonOps COMPRESSED

The singleton JsonOps instance for compressed JSON serialization.

See Also:

compressMaps()

Constructor Detail

JsonOps

protected JsonOps(boolean compressed)

Constructs a JsonOps with the given settings.

Parameters:

compressed - Whether this JsonOps should use compressed serialization.

Method Detail

empty

public JsonElement empty()

Description copied from interface: DynamicOps

Returns the empty value of the serialization type. This may be the primitive value corresponding to empty, null, absent, etc, or it may literally be the representation of "no value".

The returned value must be a singleton. That is, clients are guaranteed to be able to compare instances to empty() using reference equality (==).

Specified by:

empty in interface DynamicOps<JsonElement>

convertTo

public <U> U convertTo(DynamicOps<U> outOps,
                       JsonElement input)

Description copied from interface: DynamicOps

Converts a value of the serialization type to an equivalent value of another serialization type.

Specified by:

convertTo in interface DynamicOps<JsonElement>

Type Parameters:

U - The output serialization type.

Parameters:

outOps - The DynamicOps object used to work with the output serialization type.

input - The value to convert to the output serialization type.

Returns:

A value of the output serialization type equivalent to the input value.

getNumberValue

public DataResult<Number> getNumberValue(JsonElement input)

Description copied from interface: DynamicOps

Attempts to parse or coerce a Number value from the input.

This method may perform type coercions such as string-to-number and boolean-to-number conversion.

Specified by:

getNumberValue in interface DynamicOps<JsonElement>

Parameters:

input - The serialized value.

Returns:

A DataResult containing the parsed Number, or else an error message.

See Also:

DynamicOps.getNumberValue(Object, Number)

createNumeric

public JsonElement createNumeric(Number i)

Description copied from interface: DynamicOps

Serializes a Number value to the serialized type.

There are no restrictions on the form of the serialized value, save that calling DynamicOps.getNumberValue(Object) on the returned value should result in a value equal to i.

Specified by:

createNumeric in interface DynamicOps<JsonElement>

getBooleanValue

public DataResult<Boolean> getBooleanValue(JsonElement input)

Description copied from interface: DynamicOps

Attempts to parse or coerce a boolean value from the input.

This method may perform type coercions such as number-to-boolean conversion.

Specified by:

getBooleanValue in interface DynamicOps<JsonElement>

Parameters:

input - The serialized value.

Returns:

A DataResult containing the parsed boolean, or else an error message.

See Also:

DynamicOps.createBoolean(boolean), DynamicOps.getNumberValue(Object)

createBoolean

public JsonElement createBoolean(boolean value)

Description copied from interface: DynamicOps

Serializes a boolean value to the serialized type.

There are no restrictions on the form of the serialized value, save that calling DynamicOps.getBooleanValue(Object) on the returned value should result in a value whose value is equal to value.

Specified by:

createBoolean in interface DynamicOps<JsonElement>

See Also:

DynamicOps.getBooleanValue(Object), DynamicOps.createByte(byte)

getStringValue

public DataResult<String> getStringValue(JsonElement input)

Description copied from interface: DynamicOps

Attempts to parse or coerce a String value from the input.

This method may perform type coercions such as number-to-string and boolean-to-string conversion.

Specified by:

getStringValue in interface DynamicOps<JsonElement>

Parameters:

input - The serialized value.

Returns:

A DataResult containing the parsed String value, or else an error message.

See Also:

DynamicOps.createString(String)

createString

public JsonElement createString(String value)

Description copied from interface: DynamicOps

Serializes a String value to the serialized type.

There are no restrictions on the form of the serialized value, save that calling DynamicOps.getStringValue(Object) on the returned value should result in a value whose value is equal to value.

Specified by:

createString in interface DynamicOps<JsonElement>

See Also:

DynamicOps.getStringValue(Object)

mergeToList

public DataResult<JsonElement> mergeToList(JsonElement list,
                                           JsonElement value)

Description copied from interface: DynamicOps

Creates a new serialized list from the given serialized list with the given value appended. Only successful if first argument is a list/array or empty.

Specified by:

mergeToList in interface DynamicOps<JsonElement>

Parameters:

list - The list that is appended to.

value - The value to append to the list.

Returns:

A DataResult containing the merged list, or an error message if the lefthand argument was not a list.

mergeToList

public DataResult<JsonElement> mergeToList(JsonElement list,
                                           List<JsonElement> values)

Description copied from interface: DynamicOps

Creates a new serialized list from the given serialized list with the values from the given List appended. If list does not represent a list, or values could not be appended, and error is returned.

Specified by:

mergeToList in interface DynamicOps<JsonElement>

Parameters:

list - The list that is appended to.

values - The List of values to append.

Returns:

A DataResult containing the merged list, or else an error message.

mergeToMap

public DataResult<JsonElement> mergeToMap(JsonElement map,
                                          JsonElement key,
                                          JsonElement value)

Description copied from interface: DynamicOps

Creates a new serialized map from the given serialized map with the given key-value mapping added. Only successful if first argument is a map or empty and the key is convertible to String.

Specified by:

mergeToMap in interface DynamicOps<JsonElement>

Parameters:

map - The map to add to.

key - The key to add. The key must be convertible to String.

value - The value to add.

Returns:

A DataResult containing the merged map, or an error message if either the map or the key are of an incorrect type.

See Also:

DynamicOps.mergeToMap(Object, Map)

mergeToMap

public DataResult<JsonElement> mergeToMap(JsonElement map,
                                          MapLike<JsonElement> values)

Description copied from interface: DynamicOps

Creates a new serialized map from the given serialized map with the entries in the given MapLike added. Only successful if the first argument is a map.

Specified by:

mergeToMap in interface DynamicOps<JsonElement>

Parameters:

map - The map to add to.

values - A MapLike containing the values to add.

Returns:

A DataResult containing the merged map, or an error message if the serialized map is of an incorrect type.

See Also:

DynamicOps.mergeToMap(Object, Object, Object), MapLike

getMapValues

public DataResult<Stream<(JsonElement,JsonElement)>> getMapValues(JsonElement input)

Description copied from interface: DynamicOps

Extracts a Stream of map entries from the given serialized value.

Specified by:

getMapValues in interface DynamicOps<JsonElement>

Parameters:

input - The input value.

Returns:

A DataResult containing the extracted map entries, or an error message if input is not a map.

getMapEntries

public DataResult<((JsonElement,JsonElement) -> void) -> void> getMapEntries(JsonElement input)

Description copied from interface: DynamicOps

Extracts a Consumer from the given value that iterates over the entries of the serialized map. The returned value logically encapsulates a iteration over the entries in the given map, performing some user-specified action on each entry.

Specified by:

getMapEntries in interface DynamicOps<JsonElement>

Parameters:

input - The input value.

Returns:

An iteration over the entries in the input, which may perform some user-specified action on each entry.

See Also:

DynamicOps.getMapValues(Object)

getMap

public DataResult<MapLike<JsonElement>> getMap(JsonElement input)

Description copied from interface: DynamicOps

Extracts the entries in the given value, returning them in a MapLike object.

Specified by:

getMap in interface DynamicOps<JsonElement>

Parameters:

input - The serialized value.

Returns:

A DataResult containing the extracted entries, or an error message if the entries could not be extracted.

createMap

public JsonElement createMap(Stream<(JsonElement,JsonElement)> map)

Description copied from interface: DynamicOps

Serializes a Stream of entries to a map serialized value. The keys (first element in each entry) must be convertible to String.

Specified by:

createMap in interface DynamicOps<JsonElement>

Parameters:

map - The stream of entries.

Returns:

The serialized value.

See Also:

DynamicOps.createMap(Map)

getStream

public DataResult<Stream<JsonElement>> getStream(JsonElement input)

Description copied from interface: DynamicOps

Extracts a Stream of list elements from the given serialized value.

Specified by:

getStream in interface DynamicOps<JsonElement>

Parameters:

input - The serialized value.

Returns:

A DataResult containing the extracted elements, or an error message if the input does not represent a list.

See Also:

DynamicOps.getIntStream(Object), DynamicOps.getLongStream(Object)

getList

public DataResult<((JsonElement) -> void) -> void> getList(JsonElement input)

Description copied from interface: DynamicOps

Extracts a Consumer from the given value that iterates over the elements of the serialized list. The returned value logically encapsulates an iteration over the elements in the given list, performing some user-specified action on each element.

Specified by:

getList in interface DynamicOps<JsonElement>

Parameters:

input - The input value.

Returns:

An iteration over the elements in the input, which may perform some user-specified action on each element.

See Also:

DynamicOps.getStream(Object)

createList

public JsonElement createList(Stream<JsonElement> input)

Description copied from interface: DynamicOps

Serializes a list of values, in the form of a Stream to the serialized type.

Specified by:

createList in interface DynamicOps<JsonElement>

Parameters:

input - The elements to serialize.

Returns:

The serialized value.

remove

public JsonElement remove(JsonElement input,
                          String key)

Description copied from interface: DynamicOps

Returns an equivalent value with the entry associated with the given key removed. The input is not modified.

Specified by:

remove in interface DynamicOps<JsonElement>

Parameters:

input - The input value.

key - The key to remove.

Returns:

A value equivalent to input minus the given key. If input does not contain that key, or is not a map, then it is returned unchanged.

toString

public String toString()

Returns a String identifying this DynamicOps as a JsonOps.

Overrides:

toString in class Object

listBuilder

public ListBuilder<JsonElement> listBuilder()

Description copied from interface: DynamicOps

Returns a new ListBuilder for creating lists of the serialized type.

Specified by:

listBuilder in interface DynamicOps<JsonElement>

compressMaps

public boolean compressMaps()

Whether the caller should serialize maps using a compressed representation.

Specified by:

compressMaps in interface DynamicOps<JsonElement>

Implementation Requirements:

This implementation returns whether this object uses compressed serialization.

See Also:

INSTANCE, COMPRESSED

mapBuilder

public RecordBuilder<JsonElement> mapBuilder()

Description copied from interface: DynamicOps

Returns a new RecordBuilder for creating maps of the serialized type.

Specified by:

mapBuilder in interface DynamicOps<JsonElement>