Package xyz.gmitch215.socketmc.util

Interface DataHolder

All Known Implementing Classes:

DefaultScreen, RenderInstruction, RenderInstruction.DebugRenderer, RenderInstruction.GameRenderer

public interface DataHolder

Represents an object that holds an immutable map of data.

Method Summary

Modifier and Type	Method	Description
default @Nullable Object	data(@NotNull String key)	Gets a specific piece of data from this object.
default <T> T	data(@NotNull String key, @NotNull Class<T> clazz)	Gets a specific piece of data from this object.
default <T> T	data(@NotNull String key, @NotNull Class<T> clazz, T def)	Gets a specific piece of data from this object.
default @NotNull Object	data(@NotNull String key, @NotNull Object def)	Gets a specific piece of data from this object.
@NotNull @Unmodifiable Map<String,Object>	getData()	Gets an immutable copy for the data for this object.

Method Details

getData

@NotNull
@NotNull @Unmodifiable Map<String,Object> getData()

Gets an immutable copy for the data for this object.

Returns:

Screen Data

data

@Nullable
default @Nullable Object data(@NotNull
 @NotNull String key)
                       throws IllegalArgumentException

Gets a specific piece of data from this object.

Parameters:

key - Data Key

Returns:

Data Value

Throws:

IllegalArgumentException - if key is null

data

@NotNull
default @NotNull Object data(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull Object def)
                      throws IllegalArgumentException

Gets a specific piece of data from this object.

Parameters:

key - Data Key

def - Default Value

Returns:

Data Value

Throws:

IllegalArgumentException - if key or default value are null

data

@Nullable
default <T> T data(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull Class<T> clazz)
            throws IllegalArgumentException

Gets a specific piece of data from this object.

Type Parameters:

T - Data Type

Parameters:

key - Data Key

clazz - Data Class

Returns:

Data Value

Throws:

IllegalArgumentException - if key or class are null

data

@NotNull
default <T> T data(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull Class<T> clazz,
 @NotNull
 T def)
            throws IllegalArgumentException

Gets a specific piece of data from this object.

Type Parameters:

T - Data Type

Parameters:

key - Data Key

clazz - Data Class

def - Default Value

Returns:

Data Value

Throws:

IllegalArgumentException - if key, class, or default value are null