org.spongepowered.api.data.key

Interface Key<V extends BaseValue<?>>

Type Parameters:

V - The type of BaseValue

All Superinterfaces:

CatalogType

@CatalogedBy(value=Keys.class)
public interface Key<V extends BaseValue<?>>
extends CatalogType

Represents a key to an underlying BaseValue such that the underlying value can be retrieved from a ValueContainer. As well, a Key can be used for DataSerializables with the included getQuery() to retrieve the recommended DataQuery to use.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Key.Builder<E,V extends BaseValue<E>>

Method Summary

Modifier and Type	Method and Description
static Key.Builder<?,?>	builder() Creates a Key.Builder which allows creation of a Key to later be registered for accessing values from a ValueContainer.
TypeToken<?>	getElementToken() Gets the class of the element of the BaseValue this Key is representing.
DataQuery	getQuery() Gets the DataQuery for recommended use with DataContainers.
TypeToken<V>	getValueToken() Gets the class of the BaseValue this Key is representing.
<E extends DataHolder> void	registerEvent(Class<E> holderFilter, EventListener<ChangeDataHolderEvent.ValueChange> listener) Register an event listener which listens to the value the key accesses changing.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static Key.Builder<?,?> builder()

Creates a Key.Builder which allows creation of a Key to later be registered for accessing values from a ValueContainer.

Returns:

The key builder

getValueToken

TypeToken<V> getValueToken()

Gets the class of the BaseValue this Key is representing.

Returns:

The value class

getElementToken

TypeToken<?> getElementToken()

Gets the class of the element of the BaseValue this Key is representing. On occasion, if the element is a Collection type, one can occasionally use TypeToken.resolveType(Type) with Class.getTypeParameters() as the type parameter of a collection is retrievable, such as the element type parameter for List or Map.

Returns:

The element class

getQuery

DataQuery getQuery()

Gets the DataQuery for recommended use with DataContainers.

Returns:

The recommended DataQuery for use

registerEvent

<E extends DataHolder> void registerEvent(Class<E> holderFilter,
                                          EventListener<ChangeDataHolderEvent.ValueChange> listener)

Register an event listener which listens to the value the key accesses changing.

Type Parameters:

E - The class type of the data holder

Parameters:

holderFilter - The data holder to filter with

listener - The event listener