Package org.spongepowered.api.data

Interface DataRegistration.Builder

All Superinterfaces:

AbstractBuilder<DataRegistration>, Buildable.Builder<DataRegistration>, Builder<DataRegistration,DataRegistration.Builder>, ResettableBuilder<DataRegistration,DataRegistration.Builder>

Enclosing interface:

DataRegistration

public static interface DataRegistration.Builder
extends Builder<DataRegistration,DataRegistration.Builder>

A standard builder for constructing new DataRegistrations. It's always advised to create a new builder with DataRegistration.builder() and calling reset() when re-using said builder.

Method Summary

Modifier and Type	Method	Description
DataRegistration	build()
DataRegistration.Builder	dataKey(java.lang.Iterable<Key<?>> keys)	Gives the Key to this builder signifying the key is to be registered either with an applicable DataProvider or an associated DataStore that will provide serialization/deserialization behaviors.
DataRegistration.Builder	dataKey(Key<?> key)	Gives the Key to this builder signifying the key is to be registered either with an applicable DataProvider or an associated DataStore that will provide serialization/deserialization behaviors.
DataRegistration.Builder	dataKey(Key<?> key, Key<?>... others)	Gives the Key to this builder signifying the key is to be registered either with an applicable DataProvider or an associated DataStore that will provide serialization/deserialization behaviors.
DataRegistration.Builder	provider(DataProvider<?,?> provider)	Gives the builder a DataProvider of which is registered for a particular Key.
DataRegistration.Builder	reset()	Resets this builder to a "default" state such that there is no remaining data to set.
DataRegistration.Builder	store(DataStore store)	Gives the builder a DataStore that will enable supporting serializing and de-serializing Values given a context of a specific DataHolder by TypeToken.

Method Detail

store

DataRegistration.Builder store(DataStore store)
                        throws DuplicateDataStoreException

Gives the builder a DataStore that will enable supporting serializing and de-serializing Values given a context of a specific DataHolder by TypeToken. It is recommended that if the Keys are meant to be all grouped/controlled together, a single DataStore is to serialize/de-serialize any and all Values for those Keys.

Parameters:

store - The data store providing the serialization process

Returns:

This builder, for chaining

Throws:

DuplicateDataStoreException - If the DataStore is already registered for the type token it uses

provider

DataRegistration.Builder provider(DataProvider<?,?> provider)
                           throws DuplicateProviderException

Gives the builder a DataProvider of which is registered for a particular Key. If a DataProvider already exists for the Key, a DuplicateProviderException can be thrown.

Note that by supplying a DataProvider, the Values with the provider's Key will NOT be passed to any potentially registered DataStores for serialization. A Key that has a DataProvider will always pass through that DataProvider, and never a DataStore.

Parameters:

provider - The provider

Returns:

This builder, for chaining

Throws:

DuplicateProviderException - If there is already a DataProvider for the key

dataKey

DataRegistration.Builder dataKey(Key<?> key)

Gives the Key to this builder signifying the key is to be registered either with an applicable DataProvider or an associated DataStore that will provide serialization/deserialization behaviors. A Key alone in the registration will allow for the understanding that the Key's Value will be constructed/provided for for various DataHolders either through a DataProvider dynamically, or by a serialization strategy by a contextualized DataStore.

Parameters:

key - The key to register

Returns:

This builder, for chaining

dataKey

DataRegistration.Builder dataKey(Key<?> key,
                                 Key<?>... others)

Gives the Key to this builder signifying the key is to be registered either with an applicable DataProvider or an associated DataStore that will provide serialization/deserialization behaviors. A Key alone in the registration will allow for the understanding that the Key's Value will be constructed/provided for for various DataHolders either through a DataProvider dynamically, or by a serialization strategy by a contextualized DataStore.

Parameters:

key - The key to register

others - The additional keys

Returns:

This builder, for chaining

dataKey

DataRegistration.Builder dataKey(java.lang.Iterable<Key<?>> keys)

Gives the Key to this builder signifying the key is to be registered either with an applicable DataProvider or an associated DataStore that will provide serialization/deserialization behaviors. A Key alone in the registration will allow for the understanding that the Key's Value will be constructed/provided for for various DataHolders either through a DataProvider dynamically, or by a serialization strategy by a contextualized DataStore.

Parameters:

keys - The key to register

Returns:

This builder, for chaining

reset

DataRegistration.Builder reset()

Description copied from interface: Builder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface Builder<DataRegistration,DataRegistration.Builder>

Specified by:

reset in interface ResettableBuilder<DataRegistration,DataRegistration.Builder>

Returns:

This builder, for chaining

build

DataRegistration build()

Specified by:

build in interface AbstractBuilder<DataRegistration>

Specified by:

build in interface Buildable.Builder<DataRegistration>

Returns:

The data registration object

Throws:

java.lang.IllegalStateException - If registrations can no longer take place

java.lang.IllegalStateException - If there are no Keys registered in this registration

java.lang.IllegalStateException - If there are no DataProviders or DataStores, resulting in the keys being dynamic

DataAlreadyRegisteredException - If a key has already been claimed by another registration