org.spongepowered.api.data.manipulator

Interface ImmutableDataManipulatorBuilder<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>

All Superinterfaces:

DataBuilder<I>, ResettableBuilder<I,DataBuilder<I>>

public interface ImmutableDataManipulatorBuilder<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>
extends DataBuilder<I>

Method Summary

Modifier and Type	Method and Description
Optional<I>	createFrom(DataHolder dataHolder) Attempts to read data from the given DataHolder and constructs a new copy of the DataManipulator as an instance of T.
Optional<I>	createFrom(ImmutableDataHolder<?> dataHolder) Creates the desired ImmutableDataManipulator from the provided ImmutableDataHolder, if it is supported.
I	createImmutable() Creates a new specific ImmutableDataManipulator for consumption.
ImmutableDataManipulatorBuilder<I,M>	reset() Resets this builder to a "default" state such that there is no remaining data to set.

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

build, from

Method Detail

createImmutable

I createImmutable()

Creates a new specific ImmutableDataManipulator for consumption.

Returns:

The newly created immutable data manipulator

createFrom

Optional<I> 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

createFrom

Optional<I> createFrom(ImmutableDataHolder<?> dataHolder)

Creates the desired ImmutableDataManipulator from the provided ImmutableDataHolder, if it is supported.

Parameters:

dataHolder - The data holder

Returns:

The immutable manipulator, if available

reset

ImmutableDataManipulatorBuilder<I,M> 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 DataBuilder<I extends ImmutableDataManipulator<I,M>>

Specified by:

reset in interface ResettableBuilder<I extends ImmutableDataManipulator<I,M>,DataBuilder<I extends ImmutableDataManipulator<I,M>>>

Returns:

This builder, for chaining