net.lenni0451.mcstructs.text.serializer.v1_20_3

Interface CodecUtils_v1_20_3

All Known Implementing Classes:

JsonHoverEventSerializer_v1_20_3, JsonHoverEventSerializer_v1_20_5, JsonStyleSerializer_v1_20_3, JsonStyleSerializer_v1_20_5, JsonTextSerializer_v1_20_3, JsonTextSerializer_v1_20_5, NbtHoverEventSerializer_v1_20_3, NbtHoverEventSerializer_v1_20_5, NbtStyleSerializer_v1_20_3, NbtTextSerializer_v1_20_3

@ParametersAreNonnullByDefault
public interface CodecUtils_v1_20_3

Basic util methods for text component codecs based on Minecraft 1.20.3.

Method Summary

Modifier and Type	Method and Description
default boolean	containsArray(com.google.gson.JsonObject obj, java.lang.String name) Check if the given json object contains a json array.
default boolean	containsObject(com.google.gson.JsonObject obj, java.lang.String name) Check if the given json object contains a json object.
default boolean	containsString(com.google.gson.JsonObject obj, java.lang.String name) Check if the given json object contains a boolean.
default boolean	isNumber(com.google.gson.JsonElement element) Check if the given element is a number.
default boolean	isObject(com.google.gson.JsonElement element) Check if the given element is an array.
default boolean	isString(com.google.gson.JsonElement element) Check if the given element is a string.
default java.lang.Boolean	optionalBoolean(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional boolean or null if not present.
default java.lang.Boolean	optionalBoolean(com.google.gson.JsonObject obj, java.lang.String name) Get an optional boolean or null if not present.
default net.lenni0451.mcstructs.nbt.tags.CompoundTag	optionalCompound(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional compound tag or null if not present.
default java.lang.Integer	optionalInt(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional int or null if not present.
default java.lang.Integer	optionalInt(com.google.gson.JsonObject obj, java.lang.String name) Get an optional int or null if not present.
default com.google.gson.JsonObject	optionalObject(com.google.gson.JsonObject obj, java.lang.String name) Get an optional json object or null if not present.
default java.lang.String	optionalString(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional string or null if not present.
default java.lang.String	optionalString(com.google.gson.JsonObject obj, java.lang.String name) Get an optional string or null if not present.
default boolean	requiredBoolean(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get a required boolean or throw an exception if not present.
default boolean	requiredBoolean(com.google.gson.JsonObject obj, java.lang.String name) Get a required boolean or throw an exception if not present.
default net.lenni0451.mcstructs.nbt.tags.CompoundTag	requiredCompound(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get a required compound tag or throw an exception if not present.
default int	requiredInt(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get a required int or throw an exception if not present.
default int	requiredInt(com.google.gson.JsonObject obj, java.lang.String name) Get a required int or throw an exception if not present.
default com.google.gson.JsonObject	requiredObject(com.google.gson.JsonObject obj, java.lang.String name) Get a required json object or throw an exception if not present.
default java.lang.String	requiredString(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get a required string or throw an exception if not present.
default java.lang.String	requiredString(com.google.gson.JsonObject obj, java.lang.String name) Get a required string or throw an exception if not present.
default java.util.List<net.lenni0451.mcstructs.nbt.INbtTag>	unwrapMarkers(net.lenni0451.mcstructs.nbt.tags.ListTag<?> list) Unwrap all marker tags from the given list.

Method Detail

unwrapMarkers

default java.util.List<net.lenni0451.mcstructs.nbt.INbtTag> unwrapMarkers(net.lenni0451.mcstructs.nbt.tags.ListTag<?> list)

Unwrap all marker tags from the given list.
A marker tag is a compound tag with only one entry with an empty key (e.g. {"":123}).

Parameters:

list - The list to unwrap

Returns:

The unwrapped list

isString

default boolean isString(@Nullable
                         com.google.gson.JsonElement element)

Check if the given element is a string.

Parameters:

element - The element to check

Returns:

If the element is a string

isNumber

default boolean isNumber(@Nullable
                         com.google.gson.JsonElement element)

Check if the given element is a number.

Parameters:

element - The element to check

Returns:

If the element is a number

isObject

default boolean isObject(@Nullable
                         com.google.gson.JsonElement element)

Check if the given element is an array.

Parameters:

element - The element to check

Returns:

If the element is an array

containsString

default boolean containsString(com.google.gson.JsonObject obj,
                               java.lang.String name)

Check if the given json object contains a boolean.

Parameters:

obj - The object to check

name - The name of the boolean

Returns:

If the object contains the boolean

containsArray

default boolean containsArray(com.google.gson.JsonObject obj,
                              java.lang.String name)

Check if the given json object contains a json array.

Parameters:

obj - The object to check

name - The name of the array

Returns:

If the object contains the array

containsObject

default boolean containsObject(com.google.gson.JsonObject obj,
                               java.lang.String name)

Check if the given json object contains a json object.

Parameters:

obj - The object to check

name - The name of the object

Returns:

If the object contains the object

optionalBoolean

@Nullable
default java.lang.Boolean optionalBoolean(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                                     java.lang.String name)

Get an optional boolean or null if not present.

Parameters:

tag - The tag to get the boolean from

name - The name of the boolean

Returns:

The boolean or null if not present

optionalBoolean

@Nullable
default java.lang.Boolean optionalBoolean(com.google.gson.JsonObject obj,
                                                     java.lang.String name)

Get an optional boolean or null if not present.

Parameters:

obj - The object to get the boolean from

name - The name of the boolean

Returns:

The boolean or null if not present

optionalInt

@Nullable
default java.lang.Integer optionalInt(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                                 java.lang.String name)

Get an optional int or null if not present.

Parameters:

tag - The tag to get the int from

name - The name of the int

Returns:

The int or null if not present

optionalInt

@Nullable
default java.lang.Integer optionalInt(com.google.gson.JsonObject obj,
                                                 java.lang.String name)

Get an optional int or null if not present.

Parameters:

obj - The object to get the int from

name - The name of the int

Returns:

The int or null if not present

optionalString

@Nullable
default java.lang.String optionalString(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                                   java.lang.String name)

Get an optional string or null if not present.

Parameters:

tag - The tag to get the string from

name - The name of the string

Returns:

The string or null if not present

optionalString

@Nullable
default java.lang.String optionalString(com.google.gson.JsonObject obj,
                                                   java.lang.String name)

Get an optional string or null if not present.

Parameters:

obj - The object to get the string from

name - The name of the string

Returns:

The string or null if not present

optionalCompound

@Nullable
default net.lenni0451.mcstructs.nbt.tags.CompoundTag optionalCompound(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                                                                 java.lang.String name)

Get an optional compound tag or null if not present.

Parameters:

tag - The tag to get the compound from

name - The name of the compound

Returns:

The compound or null if not present

optionalObject

@Nullable
default com.google.gson.JsonObject optionalObject(com.google.gson.JsonObject obj,
                                                             java.lang.String name)

Get an optional json object or null if not present.

Parameters:

obj - The object to get the object from

name - The name of the object

Returns:

The object or null if not present

requiredBoolean

default boolean requiredBoolean(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                java.lang.String name)

Get a required boolean or throw an exception if not present.

Parameters:

tag - The tag to get the boolean from

name - The name of the boolean

Returns:

The boolean

Throws:

java.lang.IllegalArgumentException - If the boolean is not present

requiredBoolean

default boolean requiredBoolean(com.google.gson.JsonObject obj,
                                java.lang.String name)

Get a required boolean or throw an exception if not present.

Parameters:

obj - The object to get the boolean from

name - The name of the boolean

Returns:

The boolean

requiredInt

default int requiredInt(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                        java.lang.String name)

Get a required int or throw an exception if not present.

Parameters:

tag - The tag to get the int from

name - The name of the int

Returns:

The int

requiredInt

default int requiredInt(com.google.gson.JsonObject obj,
                        java.lang.String name)

Get a required int or throw an exception if not present.

Parameters:

obj - The object to get the int from

name - The name of the int

Returns:

The int

requiredString

default java.lang.String requiredString(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                        java.lang.String name)

Get a required string or throw an exception if not present.

Parameters:

tag - The tag to get the string from

name - The name of the string

Returns:

The string

requiredString

default java.lang.String requiredString(com.google.gson.JsonObject obj,
                                        java.lang.String name)

Get a required string or throw an exception if not present.

Parameters:

obj - The object to get the string from

name - The name of the string

Returns:

The string

requiredCompound

default net.lenni0451.mcstructs.nbt.tags.CompoundTag requiredCompound(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag,
                                                                      java.lang.String name)

Get a required compound tag or throw an exception if not present.

Parameters:

tag - The tag to get the compound from

name - The name of the compound

Returns:

The compound

requiredObject

default com.google.gson.JsonObject requiredObject(com.google.gson.JsonObject obj,
                                                  java.lang.String name)

Get a required json object or throw an exception if not present.

Parameters:

obj - The object to get the object from

name - The name of the object

Returns:

The object