org.spongepowered.api.data.key

Interface Key.Builder<E,V extends BaseValue<E>>

All Superinterfaces:

CatalogBuilder<Key<V>,Key.Builder<E,V>>, ResettableBuilder<Key<V>,Key.Builder<E,V>>

Enclosing interface:

Key<V extends BaseValue<?>>

public static interface Key.Builder<E,V extends BaseValue<E>>
extends CatalogBuilder<Key<V>,Key.Builder<E,V>>

Method Summary

Modifier and Type	Method and Description
Key<V>	build() Builds a new Key, provided that the type(TypeToken), id(String), name(String), and query(DataQuery) are set.
default Key.Builder<E,V>	from(Key<V> value) Deprecated.
Key.Builder<E,V>	id(String id) Sets the id of the CatalogType (without the namespace/plugin id).
Key.Builder<E,V>	name(String name) Sets the name of the CatalogType.
Key.Builder<E,V>	query(DataQuery query) Sets the DataQuery recommended for use with DataContainers.
<T,B extends BaseValue<T>> Key.Builder<T,B>	type(TypeToken<B> token) Starter method for the builder, to be used immediately after Key.builder() is called.

Methods inherited from interface org.spongepowered.api.util.CatalogBuilder

name

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

reset

Method Detail

type

<T,B extends BaseValue<T>> Key.Builder<T,B> type(TypeToken<B> token)

Starter method for the builder, to be used immediately after Key.builder() is called. This defines the generics for the builder itself to provide the properly generified Key.

Common TypeTokens can be found in TypeTokens. If a new TypeToken is to be created, it is recommended to create an anonymous class instance of a token, as recommended by Guava's wiki found here.

Type Parameters:

T - The element type of the Key

B - The base value type of the key

Parameters:

token - The type token, preferably an anonymous

Returns:

This builder, generified

id

Key.Builder<E,V> id(String id)

Description copied from interface: CatalogBuilder

Sets the id of the CatalogType (without the namespace/plugin id).

Specified by:

id in interface CatalogBuilder<Key<V extends BaseValue<E>>,Key.Builder<E,V extends BaseValue<E>>>

Parameters:

id - The id

Returns:

This builder for chaining

name

Key.Builder<E,V> name(String name)

Description copied from interface: CatalogBuilder

Sets the name of the CatalogType. Defaults to CatalogBuilder.id(String).

Specified by:

name in interface CatalogBuilder<Key<V extends BaseValue<E>>,Key.Builder<E,V extends BaseValue<E>>>

Parameters:

name - The name

Returns:

This builder for chaining

query

Key.Builder<E,V> query(DataQuery query)

Sets the DataQuery recommended for use with DataContainers. See Key.getQuery().

Parameters:

query - The DataQuery

Returns:

This builder, for chaining

build

Key<V> build()

Builds a new Key, provided that the type(TypeToken), id(String), name(String), and query(DataQuery) are set.

Specified by:

build in interface CatalogBuilder<Key<V extends BaseValue<E>>,Key.Builder<E,V extends BaseValue<E>>>

Returns:

The generated Key

from

@Deprecated
default Key.Builder<E,V> from(Key<V> value)
                                   throws UnsupportedOperationException

Deprecated.

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface CatalogBuilder<Key<V extends BaseValue<E>>,Key.Builder<E,V extends BaseValue<E>>>

Specified by:

from in interface ResettableBuilder<Key<V extends BaseValue<E>>,Key.Builder<E,V extends BaseValue<E>>>

Parameters:

value - The built object

Returns:

This builder, for chaining

Throws:

UnsupportedOperationException