me.lucko.helper.metadata

Interface MetadataKey<T>

Type Parameters:

T - the value type

All Superinterfaces:

TypeAware<T>

@NonnullByDefault
public interface MetadataKey<T>
extends TypeAware<T>

A MetadataKey can be mapped to values in a MetadataMap.

Unlike a normal map key, a MetadataKey also holds the type of the values mapped to it.

Method Summary

Modifier and Type	Method and Description
T	cast(Object object) Attempts to cast the given object to the return type of the key
static <T> MetadataKey<T>	create(String id, Class<T> clazz) Creates a MetadataKey with the given id and type
static <T> MetadataKey<T>	create(String id, TypeToken<T> type) Creates a MetadataKey with the given id and type
static MetadataKey<Boolean>	createBooleanKey(String id)
static MetadataKey<Character>	createCharacterKey(String id)
static MetadataKey<Cooldown>	createCooldownKey(String id)
static MetadataKey<Double>	createDoubleKey(String id)
static MetadataKey<Empty>	createEmptyKey(String id)
static MetadataKey<Float>	createFloatKey(String id)
static MetadataKey<Integer>	createIntegerKey(String id)
static MetadataKey<Long>	createLongKey(String id)
static MetadataKey<Short>	createShortKey(String id)
static MetadataKey<String>	createStringKey(String id)
static MetadataKey<UUID>	createUuidKey(String id)
String	getId() Gets the id of this key.
TypeToken<T>	getType() Get the type of the value mapped to this key

Method Detail

create

static <T> MetadataKey<T> create(String id,
                                 TypeToken<T> type)

Creates a MetadataKey with the given id and type

Type Parameters:

T - the value type

Parameters:

id - the id of the key

type - the type of the value mapped to this key

Returns:

a new metadata key

create

static <T> MetadataKey<T> create(String id,
                                 Class<T> clazz)

Creates a MetadataKey with the given id and type

Type Parameters:

T - the value type

Parameters:

id - the id of the key

clazz - the class type of the value mapped to this key

Returns:

a new metadata key

createEmptyKey

static MetadataKey<Empty> createEmptyKey(String id)

createStringKey

static MetadataKey<String> createStringKey(String id)

createBooleanKey

static MetadataKey<Boolean> createBooleanKey(String id)

createIntegerKey

static MetadataKey<Integer> createIntegerKey(String id)

createLongKey

static MetadataKey<Long> createLongKey(String id)

createDoubleKey

static MetadataKey<Double> createDoubleKey(String id)

createFloatKey

static MetadataKey<Float> createFloatKey(String id)

createShortKey

static MetadataKey<Short> createShortKey(String id)

createCharacterKey

static MetadataKey<Character> createCharacterKey(String id)

createCooldownKey

static MetadataKey<Cooldown> createCooldownKey(String id)

createUuidKey

static MetadataKey<UUID> createUuidKey(String id)

getId

String getId()

Gets the id of this key. May be automatically lowercase'd

Returns:

the id of this key

getType

TypeToken<T> getType()

Get the type of the value mapped to this key

Specified by:

getType in interface TypeAware<T>

Returns:

the type of the value

cast

T cast(Object object)
throws ClassCastException

Attempts to cast the given object to the return type of the key

Parameters:

object - the object to be casted

Returns:

a casted object

Throws:

ClassCastException - if the object cannot be casted