org.spongepowered.api.data.key

Class KeyFactory

java.lang.Object

org.spongepowered.api.data.key.KeyFactory

Deprecated.

To be removed in future API versions. Use Key.builder() to create keys.

@Deprecated
public final class KeyFactory
extends Object

A factory of Keys, useful for both the implementation of SpongeAPI, and for plugins wishing to provide their own Keys without having to remain afraid of having to cast back and forth.

Method Summary

Modifier and Type	Method and Description
static <E> Key<ListValue<E>>	makeListKey(TypeToken<? extends List<E>> elementToken, TypeToken<ListValue<E>> valueToken, DataQuery query, String id, String name) Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions
static <K,V> Key<MapValue<K,V>>	makeMapKey(TypeToken<Map<K,V>> elementToken, TypeToken<MapValue<K,V>> valueToken, DataQuery query, String id, String name) Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions
static <E> Key<OptionalValue<E>>	makeOptionalKey(TypeToken<Optional<E>> elementToken, TypeToken<OptionalValue<E>> valueToken, DataQuery query, String id, String name) Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions
static <E> Key<SetValue<E>>	makeSetKey(TypeToken<? extends Set<E>> elementToken, TypeToken<SetValue<E>> valueToken, DataQuery query, String id, String name) Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions
static <E,V extends BaseValue<E>> Key<V>	makeSingleKey(TypeToken<E> elementToken, TypeToken<V> valueToken, DataQuery query, String id, String name) Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions

Methods inherited from class java.lang.Object

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

Method Detail

makeSingleKey

@Deprecated
public static <E,V extends BaseValue<E>> Key<V> makeSingleKey(TypeToken<E> elementToken,
                                                                          TypeToken<V> valueToken,
                                                                          DataQuery query,
                                                                          String id,
                                                                          String name)

Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions

Creates a new Key with the provided E element class and V Value class along with the provided default DataQuery to be used with the generated Key.

Note that Keys are not registered, but it is recommended to avoid generating Keys of potentially conflicting DataQuery(s).

Type Parameters:

E - The type of element

V - The inferred return type

Parameters:

elementToken - The element class

valueToken - The value class

query - The query

id - The id for the new key

name - The name for the new key

Returns:

The generated key

makeListKey

@Deprecated
public static <E> Key<ListValue<E>> makeListKey(TypeToken<? extends List<E>> elementToken,
                                                            TypeToken<ListValue<E>> valueToken,
                                                            DataQuery query,
                                                            String id,
                                                            String name)

Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions

Creates a new Key based on a ListValue of a type E element along with the provided DataQuery.

Type Parameters:

E - The type of element

Parameters:

elementToken - The element class

valueToken - The value class

query - The query to access the data

id - The id for the new key

name - The name for the new key

Returns:

The generated key

makeSetKey

@Deprecated
public static <E> Key<SetValue<E>> makeSetKey(TypeToken<? extends Set<E>> elementToken,
                                                          TypeToken<SetValue<E>> valueToken,
                                                          DataQuery query,
                                                          String id,
                                                          String name)

Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions

Creates a new Key based on a SetValue of a type E element along with the provided DataQuery.

Type Parameters:

E - The type of element

Parameters:

elementToken - The element class

valueToken - The value token

query - The query to access the data

id - The id for the new key

name - The name for the new key

Returns:

The generated key

makeMapKey

@Deprecated
public static <K,V> Key<MapValue<K,V>> makeMapKey(TypeToken<Map<K,V>> elementToken,
                                                              TypeToken<MapValue<K,V>> valueToken,
                                                              DataQuery query,
                                                              String id,
                                                              String name)

Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions

Creates a new Key based on a MapValue of the types K keys and V values with the provided DataQuery for accessing the Map in DataViews.

Type Parameters:

K - The type of keys

V - The type of values

Parameters:

elementToken - The element token

valueToken - The value class of the map

query - The query

id - The id for the new key

name - The name for the new key

Returns:

The generated key

makeOptionalKey

@Deprecated
public static <E> Key<OptionalValue<E>> makeOptionalKey(TypeToken<Optional<E>> elementToken,
                                                                    TypeToken<OptionalValue<E>> valueToken,
                                                                    DataQuery query,
                                                                    String id,
                                                                    String name)

Deprecated. Use Key.builder() to build keys. Implementation is being removed in future API versions

Creates a new Key based on an OptionalValue of the type E element type with the provided DataQuery for accessing the optionally null value in DataViews.

Type Parameters:

E - The element type

Parameters:

elementToken - The element class

valueToken - The value class

query - The query

id - The id for the new key

name - The name for the new key

Returns:

The generated key