org.spongepowered.api.data

Interface ImmutableDataBuilder<H extends ImmutableDataHolder<H>,E extends ImmutableDataBuilder<H,E>>

Type Parameters:

H - The type of ImmutableDataHolder

E - The extended ImmutableDataBuilder

All Superinterfaces:

DataBuilder<H>, ResettableBuilder<H,DataBuilder<H>>

All Known Subinterfaces:

BlockSnapshot.Builder, BlockState.Builder, EntitySnapshot.Builder, FluidStackSnapshot.Builder

public interface ImmutableDataBuilder<H extends ImmutableDataHolder<H>,E extends ImmutableDataBuilder<H,E>>
extends DataBuilder<H>

A builder, much like a normal DataBuilder except that it builds ImmutableDataHolders. While the ImmutableDataHolder is like a DataHolder, it is immutable.

Method Summary

Modifier and Type	Method and Description
E	add(DataManipulator<?,?> manipulator) Adds the given DataManipulator to the builder.
E	add(ImmutableDataManipulator<?,?> manipulator) Adds the given ImmutableDataManipulator to the builder.
<V> E	add(Key<? extends BaseValue<V>> key, V value) Adds the given Key with the given value.
H	build() Attempts to build a new ImmutableDataHolder.
E	from(H holder) Copies all known DataManipulators from the given ImmutableDataHolder.
E	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

Method Detail

add

E add(DataManipulator<?,?> manipulator)

Adds the given DataManipulator to the builder. The DataManipulator is copied when the ImmutableDataHolder is created.

Parameters:

manipulator - The manipulator to add

Returns:

This builder, for chaining

add

E add(ImmutableDataManipulator<?,?> manipulator)

Adds the given ImmutableDataManipulator to the builder.

Parameters:

manipulator - The manipulator to add

Returns:

This builder, for chaining

add

<V> E add(Key<? extends BaseValue<V>> key,
          V value)

Adds the given Key with the given value.

Type Parameters:

V - The type of the value

Parameters:

key - The key to assign the value with

value - The value to assign with the key

Returns:

This builder, for chaining

from

E from(H holder)

Copies all known DataManipulators from the given ImmutableDataHolder. This is a defensive copy as DataManipulator is mutable.

Specified by:

from in interface DataBuilder<H extends ImmutableDataHolder<H>>

Specified by:

from in interface ResettableBuilder<H extends ImmutableDataHolder<H>,DataBuilder<H extends ImmutableDataHolder<H>>>

Parameters:

holder - The ImmutableDataHolder to copy from

Returns:

This builder for chaining

build

H build()

Attempts to build a new ImmutableDataHolder.

Returns:

The new immutable data holder

reset

E 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<H extends ImmutableDataHolder<H>>

Specified by:

reset in interface ResettableBuilder<H extends ImmutableDataHolder<H>,DataBuilder<H extends ImmutableDataHolder<H>>>

Returns:

This builder, for chaining