org.spongepowered.api.data

Interface DataManager

public interface DataManager

A manager of the overall Data API. This handles the registration of DataSerializables and their DataBuilders, DataManipulators and their respective DataManipulatorBuilders, ImmutableDataManipulators and their respective ImmutableDataManipulatorBuilders, etc.

Note that this manager powers not just serialization and deserialization, but also powers a majority of the Data API.

Method Summary

Modifier and Type	Method and Description
DataContainer	createContainer() Creates a new DataContainer with a default DataView.SafetyMode of DataView.SafetyMode.ALL_DATA_CLONED.
DataContainer	createContainer(DataView.SafetyMode safety) Creates a new DataContainer with the provided DataView.SafetyMode.
<T extends DataSerializable> Optional<T>	deserialize(Class<T> clazz, DataView dataView) Attempts to translate an instance of the DataSerializable from the provided DataView.
Collection<Class<? extends DataManipulator<?,?>>>	getAllRegistrationsFor(PluginContainer container) Gets all Classes of all DataManipulators registered for the provided PluginContainer.
<T extends DataSerializable> Optional<DataBuilder<T>>	getBuilder(Class<T> clazz) Attempts to retrieve the DataBuilder for the desired DataSerializable class.
<T extends ImmutableDataHolder<T>,B extends ImmutableDataBuilder<T,B>> Optional<B>	getImmutableBuilder(Class<T> holderClass) Attempts to retrieve the builder for the given ImmutableDataHolder.
<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>> Optional<DataManipulatorBuilder<T,I>>	getImmutableManipulatorBuilder(Class<I> immutableManipulatorClass) Attempts to retrieve the builder for the given ImmutableDataManipulator.
<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>> Optional<DataManipulatorBuilder<T,I>>	getManipulatorBuilder(Class<T> manipulatorClass) Attempts to retrieve the builder for the given DataManipulator.
<T> Optional<DataTranslator<T>>	getTranslator(Class<T> objectClass) Gets the desired DataTranslator for the provided class.
<T extends DataSerializable> Optional<DataContentUpdater>	getWrappedContentUpdater(Class<T> clazz, int fromVersion, int toVersion) Gets a wrapped fake DataContentUpdater that may wrap several DataContentUpdaters to translate versioned data from the desired fromVersion to the toVersion.
<T extends ImmutableDataHolder<T>,B extends ImmutableDataBuilder<T,B>> void	register(Class<T> holderClass, B builder) Registers the given ImmutableDataHolder class with it's associated ImmutableDataBuilder.
<T extends DataSerializable> void	registerBuilder(Class<T> clazz, DataBuilder<T> builder) Registers a DataBuilder that will dynamically build the given DataSerializable from a DataContainer.
<T extends DataSerializable> void	registerContentUpdater(Class<T> clazz, DataContentUpdater updater) Registers a DataContentUpdater for the desired DataSerializable such that any versioned data may be updated to newer versions for the most up to date DataBuilder.
void	registerLegacyManipulatorIds(String legacyId, DataRegistration<?,?> registration) Registers a legacy id that is used by a previous version of DataRegistration from a plugin such that the custom data can be retained, while not being lost.
<T> void	registerTranslator(Class<T> objectClass, DataTranslator<T> translator) Deprecated. Use the event org.spongepowered.api.event.game.GameRegistryEvent.Register&lt;DataTranslator&lt;?&gt;&gt; instead

Method Detail

registerBuilder

<T extends DataSerializable> void registerBuilder(Class<T> clazz,
                                                  DataBuilder<T> builder)

Registers a DataBuilder that will dynamically build the given DataSerializable from a DataContainer.

Builders may not always exist for a given DataSerializable, nor is it guaranteed that a provided builder will function with all DataContainers.

Type Parameters:

T - The type of data serializable

Parameters:

clazz - The class of the DataSerializable

builder - The builder that can build the data serializable

registerContentUpdater

<T extends DataSerializable> void registerContentUpdater(Class<T> clazz,
                                                         DataContentUpdater updater)

Registers a DataContentUpdater for the desired DataSerializable such that any versioned data may be updated to newer versions for the most up to date DataBuilder.

Type Parameters:

T - The type of DataSerializable

Parameters:

clazz - The data serializable class

updater - The updater

getWrappedContentUpdater

<T extends DataSerializable> Optional<DataContentUpdater> getWrappedContentUpdater(Class<T> clazz,
                                                                                   int fromVersion,
                                                                                   int toVersion)

Gets a wrapped fake DataContentUpdater that may wrap several DataContentUpdaters to translate versioned data from the desired fromVersion to the toVersion. If the version jump is too great or a DataContentUpdater has not been registered to cover the complete jump, Optional.empty() may be returned.

Type Parameters:

T - The type of data serializable

Parameters:

clazz - The data serializable class

fromVersion - The version converting from

toVersion - The version converting to

Returns:

The content updater, if available

getBuilder

<T extends DataSerializable> Optional<DataBuilder<T>> getBuilder(Class<T> clazz)

Attempts to retrieve the DataBuilder for the desired DataSerializable class.

Builders may not always exist for a given DataSerializable, nor is it guaranteed that a provided builder will function with all DataContainers.

Type Parameters:

T - The type of data serializable

Parameters:

clazz - The class of the data serializable

Returns:

The builder, if available

deserialize

<T extends DataSerializable> Optional<T> deserialize(Class<T> clazz,
                                                     DataView dataView)

Attempts to translate an instance of the DataSerializable from the provided DataView. If there is no DataBuilder registered for the provided DataSerializable, then Optional.empty() may be returned.

Type Parameters:

T - The type of data serializable

Parameters:

clazz - The class of the data serializable

dataView - The data view containing raw data

Returns:

The data serializable, if available

register

<T extends ImmutableDataHolder<T>,B extends ImmutableDataBuilder<T,B>> void register(Class<T> holderClass,
                                                                                     B builder)

Registers the given ImmutableDataHolder class with it's associated ImmutableDataBuilder. The builder can be used to create new instances of the given ImmutableDataHolder for data retrieval, data representation, etc.

Type Parameters:

T - The type of immutable data holder

B - The type of immutable data builder

Parameters:

holderClass - The class of the immutable data holder

builder - The builder instance of the immutable data holder

registerLegacyManipulatorIds

void registerLegacyManipulatorIds(String legacyId,
                                  DataRegistration<?,?> registration)

Registers a legacy id that is used by a previous version of DataRegistration from a plugin such that the custom data can be retained, while not being lost.

Parameters:

legacyId - The legacy id

registration - The registration object successfully created

getImmutableBuilder

<T extends ImmutableDataHolder<T>,B extends ImmutableDataBuilder<T,B>> Optional<B> getImmutableBuilder(Class<T> holderClass)

Attempts to retrieve the builder for the given ImmutableDataHolder.

If the ImmutableDataHolder was not registered, multiple systems could fail to retrieve specific data.

Type Parameters:

T - The type of immutable data holder

B - The type of immutable data builder

Parameters:

holderClass - The immutable data holder class

Returns:

The builder, if available

getManipulatorBuilder

<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>> Optional<DataManipulatorBuilder<T,I>> getManipulatorBuilder(Class<T> manipulatorClass)

Attempts to retrieve the builder for the given DataManipulator.

If the DataManipulator was not registered, multiple systems could fail to retrieve specific data.

Type Parameters:

T - The type of manipulator

I - The type of immutable manipulator

Parameters:

manipulatorClass - The manipulator class

Returns:

The builder, if available

getImmutableManipulatorBuilder

<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>> Optional<DataManipulatorBuilder<T,I>> getImmutableManipulatorBuilder(Class<I> immutableManipulatorClass)

Attempts to retrieve the builder for the given ImmutableDataManipulator.

If the ImmutableDataManipulator was not registered, multiple systems could fail to retrieve specific data.

Type Parameters:

T - The type of DataManipulator

I - The type of ImmutableDataManipulator

Parameters:

immutableManipulatorClass - The immutable manipulator class

Returns:

The DataManipulatorBuilder, if available

registerTranslator

@Deprecated
<T> void registerTranslator(Class<T> objectClass,
                                        DataTranslator<T> translator)

Deprecated. Use the event org.spongepowered.api.event.game.GameRegistryEvent.Register<DataTranslator<?>> instead

Registers a DataTranslator for the desired class.

Type Parameters:

T - The type of object

Parameters:

objectClass - The class of the object type being managed

translator - The translator for the desired class object

getTranslator

<T> Optional<DataTranslator<T>> getTranslator(Class<T> objectClass)

Gets the desired DataTranslator for the provided class.

Type Parameters:

T - The type of object

Parameters:

objectClass - The class of the object

Returns:

The data translator, if available

getAllRegistrationsFor

Collection<Class<? extends DataManipulator<?,?>>> getAllRegistrationsFor(PluginContainer container)

Gets all Classes of all DataManipulators registered for the provided PluginContainer. The provided Collection is considered immutable and can not be modified.

Parameters:

container - The plugin container for registered classes

Returns:

The collection of all registered data manipulator classes

createContainer

DataContainer createContainer()

Creates a new DataContainer with a default DataView.SafetyMode of DataView.SafetyMode.ALL_DATA_CLONED.

Returns:

A new data container

createContainer

DataContainer createContainer(DataView.SafetyMode safety)

Creates a new DataContainer with the provided DataView.SafetyMode.

Parameters:

safety - The safety mode to use

Returns:

A new data container with the provided safety mode

See Also:

DataView.SafetyMode