org.spongepowered.api.data.persistence

Interface DataBuilder<T extends DataSerializable>

Type Parameters:

T - The type of data serializable this builder can build

All Superinterfaces:

ResettableBuilder<T,DataBuilder<T>>

All Known Subinterfaces:

BlockSnapshot.Builder, BlockState.Builder, DataManipulatorBuilder<T,I>, Enchantment.Builder, EntityArchetype.Builder, EntitySnapshot.Builder, FluidStack.Builder, FluidStackSnapshot.Builder, ImmutableDataBuilder<H,E>, ImmutableDataManipulatorBuilder<I,M>, ItemStack.Builder, LocatableBlock.Builder, ParticleEffect.Builder, PatternLayer.Builder, PotionEffect.Builder, TileEntityArchetype.Builder, TradeOffer.Builder

All Known Implementing Classes:

AbstractDataBuilder, BookViewDataBuilder, Color.Builder, RespawnLocation.Builder, TextConfigSerializer

public interface DataBuilder<T extends DataSerializable>
extends ResettableBuilder<T,DataBuilder<T>>

Represents a builder that can take a DataContainer and create a new instance of a DataSerializable. The builder should be a singleton and may not exist for every data serializable.

It is HIGHLY recommended to extend AbstractDataBuilder as it implements content updating

Method Summary

Modifier and Type	Method and Description
Optional<T>	build(DataView container) Attempts to build the provided DataSerializable from the given DataView.
default DataBuilder<T>	from(T value) Resets this builder to the values of the given built object.
default DataBuilder<T>	reset() Resets this builder to a "default" state such that there is no remaining data to set.

Method Detail

build

Optional<T> build(DataView container)
           throws InvalidDataException

Attempts to build the provided DataSerializable from the given DataView. If the DataView is invalid or missing necessary information to complete building the DataSerializable, Optional.empty() may be returned.

Parameters:

container - The container containing all necessary data

Returns:

The instance of the DataSerializable, if successful

Throws:

InvalidDataException - In the event that the builder is unable to properly construct the data serializable from the data view

reset

default DataBuilder<T> 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 ResettableBuilder<T extends DataSerializable,DataBuilder<T extends DataSerializable>>

Returns:

This builder, for chaining

from

default DataBuilder<T> from(T value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface ResettableBuilder<T extends DataSerializable,DataBuilder<T extends DataSerializable>>

Parameters:

value - The built object

Returns:

This builder, for chaining