org.spongepowered.api.data

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

All Superinterfaces:

CatalogType

public interface DataRegistration<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>
extends CatalogType

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DataRegistration.Builder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>

Method Summary

Modifier and Type	Method and Description
static DataRegistration.Builder<?,?>	builder() Creates a new DataRegistration.Builder to build a DataRegistration.
DataManipulatorBuilder<T,I>	getDataManipulatorBuilder() Gets the DataManipulatorBuilder registered for this registration.
String	getId() Gets the unique identifier of this CatalogType.
Class<? extends I>	getImmutableImplementationClass() Gets the implementing class of the ImmutableDataManipulator for this registration.
Class<I>	getImmutableManipulatorClass() Gets the ImmutableDataManipulator class for this registration.
Class<? extends T>	getImplementationClass() Gets the implementing class of the DataManipulator for this registration.
Class<T>	getManipulatorClass() Gets the DataManipulator class for this registration.
String	getName() Gets the human-readable name of this individual CatalogType.
PluginContainer	getPluginContainer() Gets the owning PluginContainer.

Method Detail

builder

static DataRegistration.Builder<?,?> builder()

Creates a new DataRegistration.Builder to build a DataRegistration. Through the use of generics, this can be duck-typed to the generics of the desired DataManipulator type to be registered.

Returns:

The new builder instance

getManipulatorClass

Class<T> getManipulatorClass()

Gets the DataManipulator class for this registration.

Returns:

The manipulator class registered

getImplementationClass

Class<? extends T> getImplementationClass()

Gets the implementing class of the DataManipulator for this registration.

Returns:

The manipulator class registered

getImmutableManipulatorClass

Class<I> getImmutableManipulatorClass()

Gets the ImmutableDataManipulator class for this registration.

Returns:

The immutable class registered

getImmutableImplementationClass

Class<? extends I> getImmutableImplementationClass()

Gets the implementing class of the ImmutableDataManipulator for this registration.

Returns:

The immutable manipulator class registered

getDataManipulatorBuilder

DataManipulatorBuilder<T,I> getDataManipulatorBuilder()

Gets the DataManipulatorBuilder registered for this registration.

Returns:

The manipulator builder

getPluginContainer

PluginContainer getPluginContainer()

Gets the owning PluginContainer.

Returns:

The owning plugin container for this registration

getId

String getId()

Description copied from interface: CatalogType

Gets the unique identifier of this CatalogType. The identifier is case insensitive, thus there cannot be another instance with a different character case. The id of this instance must remain the same for the entire duration of its existence. The identifier can be formatted however needed.

A typical id format follows the pattern of `modId:name` or `minecraft:name`. However the prefix may be omitted for default/vanilla minecraft types.

Specified by:

getId in interface CatalogType

Returns:

The unique identifier of this dummy type

getName

String getName()

Description copied from interface: CatalogType

Gets the human-readable name of this individual CatalogType. This name is not guaranteed to be unique. This value should not be used for serialization.

Specified by:

getName in interface CatalogType

Returns:

The human-readable name of this dummy type