org.spongepowered.api.data.manipulator

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

Type Parameters:

T - The type of DataManipulator

All Superinterfaces:

DataBuilder<T>, ResettableBuilder<T,DataBuilder<T>>

public interface DataManipulatorBuilder<T extends DataManipulator<T,I>,I extends ImmutableDataManipulator<I,T>>
extends DataBuilder<T>

A builder of DataManipulators. This builder can build a specific DataManipulator that can be used to pre-construct customized data prior to applying to a DataHolder.

DataManipulatorBuilders must be registered with the DataManager before they can be used by the game and plugins. Failure to do so may prevent the DataManipulator from being used.

Method Summary

Modifier and Type	Method and Description
T	create() Creates a new specific DataManipulator for consumption.
Optional<T>	createFrom(DataHolder dataHolder) Attempts to read data from the given DataHolder and constructs a new copy of the DataManipulator as an instance of T.

Methods inherited from interface org.spongepowered.api.data.persistence.DataBuilder

build, from, reset

Method Detail

create

T create()

Creates a new specific DataManipulator for consumption.

Returns:

The newly created data manipulator

createFrom

Optional<T> createFrom(DataHolder dataHolder)

Attempts to read data from the given DataHolder and constructs a new copy of the DataManipulator as an instance of T.

If the DataHolder does not contain the necessary information to pre-populate the DataManipulator, a fresh new DataManipulator is returned. If the DataManipulator is incompatible with the DataHolder, Optional.empty() is returned.

Parameters:

dataHolder - The DataHolder to extract data

Returns:

A new instance of this DataManipulator with relevant data filled from the given DataHolder, if available