org.spongepowered.api.data

Interface DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>

All Superinterfaces:

CatalogBuilder<DataRegistration<T,I>,DataRegistration.Builder<T,I>>, ResettableBuilder<DataRegistration<T,I>,DataRegistration.Builder<T,I>>

Enclosing interface:

DataRegistration<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>

public static interface DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>
extends CatalogBuilder<DataRegistration<T,I>,DataRegistration.Builder<T,I>>

Method Summary

Modifier and Type	Method and Description
DataRegistration<T,I>	build() Builds the CatalogType of type C.
default DataRegistration<T,I>	buildAndRegister(PluginContainer container) Deprecated. Use build() instead
DataRegistration.Builder<T,I>	builder(DataManipulatorBuilder<T,I> builder) Sets the DataManipulatorBuilder to be used to generate new DataManipulators and ImmutableDataManipulators.
<D extends DataManipulator<D,M>,M extends ImmutableDataManipulator<M,D>> DataRegistration.Builder<D,M>	dataClass(Class<D> manipulatorClass) Sets the DataManipulator class to be used.
DataRegistration.Builder<T,I>	dataImplementation(Class<? extends T> dataImplementationClass) Optionally sets a separate implementation class for the DataManipulator.
default DataRegistration.Builder<T,I>	dataName(String name) Deprecated. Use CatalogBuilder.name(String) instead
DataRegistration.Builder<T,I>	from(DataRegistration<T,I> value) Deprecated.
DataRegistration.Builder<T,I>	immutableClass(Class<I> immutableDataClass) Sets the immutable class.
DataRegistration.Builder<T,I>	immutableImplementation(Class<? extends I> immutableImplementationClass) Optionally sets a separate implementation class for the ImmutableDataManipulator.
default DataRegistration.Builder<T,I>	manipulatorId(String id) Deprecated. Use CatalogBuilder.id(String) instead
DataRegistration.Builder<T,I>	reset() Resets this builder to a "default" state such that there is no remaining data to set.

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

id, name, name

Method Detail

dataClass

<D extends DataManipulator<D,M>,M extends ImmutableDataManipulator<M,D>> DataRegistration.Builder<D,M> dataClass(Class<D> manipulatorClass)

Sets the DataManipulator class to be used. For the sake of generics, this method must be called prior to immutableClass(Class) to properly infer generic usage by the compiler and at runtime.

Type Parameters:

D - The type of data manipulator

M - The type of immutable data manipulator

Parameters:

manipulatorClass - The manipulator class

Returns:

This builder, properly generified, for chaining

immutableClass

DataRegistration.Builder<T,I> immutableClass(Class<I> immutableDataClass)
                                      throws IllegalStateException

Sets the immutable class. THIS MUST BE CALLED AFTER dataClass(Class)!

Parameters:

immutableDataClass - The immutable data class

Returns:

This builder, for chaining

Throws:

IllegalStateException - If the data manipulator class has not been set already

dataImplementation

DataRegistration.Builder<T,I> dataImplementation(Class<? extends T> dataImplementationClass)
                                          throws IllegalStateException

Optionally sets a separate implementation class for the DataManipulator. THIS MUST BE CALLED AFTER dataClass(Class)!

Parameters:

dataImplementationClass - The data manipulator implementation

Returns:

This builder, for chaining

Throws:

IllegalStateException - If the data manipulator class has not been set already

immutableImplementation

DataRegistration.Builder<T,I> immutableImplementation(Class<? extends I> immutableImplementationClass)
                                               throws IllegalStateException

Optionally sets a separate implementation class for the ImmutableDataManipulator. THIS MUST BE CALLED AFTER dataClass(Class)!

Parameters:

immutableImplementationClass - The immutable data manipulator implementation

Returns:

This builder, for chaining

Throws:

IllegalStateException - If the immutable data manipulator class has not been set already

manipulatorId

@Deprecated
default DataRegistration.Builder<T,I> manipulatorId(String id)

Deprecated. Use CatalogBuilder.id(String) instead

Sets the id for the manipulator. The id should be formatted according to the normal CatalogType standard: {manipulator-id| since the "pluginid" is gathered from buildAndRegister(PluginContainer) provided PluginContainer.

The importance of the id is that the id is what will be used for serialization and deserialization of custom plugin provided data, such that if the string changes, or a plugin is no longer available to register the data, the custom data being deserialized will not be available through the system, and may be lost.

Parameters:

id - The id for the manipulator

Returns:

This builder, for chaining

dataName

@Deprecated
default DataRegistration.Builder<T,I> dataName(String name)

Deprecated. Use CatalogBuilder.name(String) instead

Sets a more generalized name to refer to the registered DataManipulator as a common name.

As an example: if I have a DummyTestData, a name could be "Dummy".

Parameters:

name - The data name

Returns:

This builder, for chaining

builder

DataRegistration.Builder<T,I> builder(DataManipulatorBuilder<T,I> builder)

Sets the DataManipulatorBuilder to be used to generate new DataManipulators and ImmutableDataManipulators.

Parameters:

builder - The builder

Returns:

This builder, for chaining

from

@Deprecated
DataRegistration.Builder<T,I> from(DataRegistration<T,I> value)
                                        throws UnsupportedOperationException

Deprecated.

Since DataRegistration objects should be considered singletons in that the data registered upon creation is already preformed, creating a new DataRegistration will always fail.

Specified by:

from in interface CatalogBuilder<DataRegistration<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>,DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>>

Specified by:

from in interface ResettableBuilder<DataRegistration<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>,DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>>

Parameters:

value - The built object

Returns:

This builder, but will fail

Throws:

UnsupportedOperationException - Always will throw an exception since there can not be multiple registration objects for the same data

reset

DataRegistration.Builder<T,I> reset()

Description copied from interface: ResettableBuilder

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 ResettableBuilder<DataRegistration<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>,DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>>

Returns:

This builder, for chaining

buildAndRegister

@Deprecated
default DataRegistration<T,I> buildAndRegister(PluginContainer container)
                                                    throws IllegalStateException,
                                                           IllegalArgumentException,
                                                           DataAlreadyRegisteredException

Deprecated. Use build() instead

Registers all of the objects for the provided DataRegistration object, including the registration's DataRegistration.getManipulatorClass() for the DataManipulator and DataRegistration.getImmutableManipulatorClass() and DataRegistration.getDataManipulatorBuilder() object. More importantly, this also allows the proper identification of the DataManipulator itself by the provided DataRegistration.getId(), which, much like CatalogType.getId() is formatted with {plugin-id|:{manipulator-id|.

It is expected that as the required PluginContainer is used is not a default container from Sponge. The PluginContainer.getId() is utilized to generate the final DataRegistration.getId() for serialization purposes.

Returns:

The data registration object

Throws:

IllegalStateException - If registrations can no longer take place

IllegalArgumentException - Various reasons

DataAlreadyRegisteredException - If the classes and or builder has already been registered

build

DataRegistration<T,I> build()

Builds the CatalogType of type C.

The last PluginContainer in the cause stack will be used to determine which plugin was used to construct the CatalogType.

All of the objects for the provided DataRegistration object, including the registration's DataRegistration.getManipulatorClass() for the DataManipulator and DataRegistration.getImmutableManipulatorClass() and DataRegistration.getDataManipulatorBuilder() object will also be registered.

Specified by:

build in interface CatalogBuilder<DataRegistration<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>,DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>>

Returns:

The data registration object

Throws:

IllegalStateException - If registrations can no longer take place

IllegalArgumentException - Various reasons

DataAlreadyRegisteredException - If the classes and or builder has already been registered