net.lenni0451.mcstructs.text.utils

Class CodecUtils

java.lang.Object

net.lenni0451.mcstructs.text.utils.CodecUtils

@ParametersAreNonnullByDefault
public class CodecUtils
extends java.lang.Object

Basic util methods for text component codecs.

Constructor Summary

Constructors

Constructor and Description
CodecUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	containsArray(com.google.gson.JsonObject obj, java.lang.String name) Check if the given json object contains a json array.
static boolean	containsObject(com.google.gson.JsonObject obj, java.lang.String name) Check if the given json object contains a json object.
static boolean	containsString(com.google.gson.JsonObject obj, java.lang.String name) Check if the given json object contains a boolean.
static boolean	isNumber(com.google.gson.JsonElement element) Check if the given element is a number.
static boolean	isObject(com.google.gson.JsonElement element) Check if the given element is an array.
static boolean	isString(com.google.gson.JsonElement element) Check if the given element is a string.
static java.lang.Boolean	optionalBoolean(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional boolean or null if not present.
static java.lang.Boolean	optionalBoolean(com.google.gson.JsonObject obj, java.lang.String name) Get an optional boolean or null if not present.
static java.lang.Integer	optionalInt(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional int or null if not present.
static java.lang.Integer	optionalInt(com.google.gson.JsonObject obj, java.lang.String name) Get an optional int or null if not present.
static java.lang.String	optionalString(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get an optional string or null if not present.
static java.lang.String	optionalString(com.google.gson.JsonObject obj, java.lang.String name) Get an optional string or null if not present.
static boolean	requiredBoolean(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get a required boolean or throw an exception if not present.
static boolean	requiredBoolean(com.google.gson.JsonObject obj, java.lang.String name) Get a required boolean or throw an exception if not present.
static 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.
static int	requiredInt(net.lenni0451.mcstructs.nbt.tags.CompoundTag tag, java.lang.String name) Get a required int or throw an exception if not present.
static int	requiredInt(com.google.gson.JsonObject obj, java.lang.String name) Get a required int or throw an exception if not present.
static 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.
static 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.
static java.lang.String	requiredString(com.google.gson.JsonObject obj, java.lang.String name) Get a required string or throw an exception if not present.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodecUtils

public CodecUtils()

Method Detail

isString

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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
public static 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
public static 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
public static 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
public static 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
public static 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
public static 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

requiredBoolean

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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