Package org.spongepowered.api.data.persistence

Class AbstractDataBuilder<T extends DataSerializable>

java.lang.Object

org.spongepowered.api.data.persistence.AbstractDataBuilder<T>

Type Parameters:

T - The type of DataSerializable

All Implemented Interfaces:

DataBuilder<T>

Direct Known Subclasses:

Color.Builder, RespawnLocation.Builder

public abstract class AbstractDataBuilder<T extends DataSerializable>
extends Object
implements DataBuilder<T>

An abstract implementation of DataBuilder that pre-defines all of the necessary "content update" implementation required for content versioning. Note that the builder itself is versioned to ensure that content versioning is appropriately handled. It is highly recommended to extend this class to implement DataBuilder and implement DataContentUpdaters as necessary for future upgradeability of custom content.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataBuilder(Class<T> requiredClass, int supportedVersion)

Method Summary

Modifier and Type	Method	Description
Optional<T>	build(DataView container)	Attempts to build the provided DataSerializable from the given DataView.
protected abstract Optional<T>	buildContent(DataView container)	Builds the currently supportedVersion variant of the intended DataSerializable, such that all content upgrades have already been handled by build(DataView).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDataBuilder

protected AbstractDataBuilder(Class<T> requiredClass,
                              int supportedVersion)

Method Detail

buildContent

protected abstract Optional<T> buildContent(DataView container)
                                     throws InvalidDataException

Builds the currently supportedVersion variant of the intended DataSerializable, such that all content upgrades have already been handled by build(DataView). This otherwise follows the same contract as DataBuilder.build(DataView).

Parameters:

container - The container with data to build from

Returns:

The deserialized data serializable, if possible

Throws:

InvalidDataException - If there's issues of invalid data formats or invalid data

build

public final Optional<T> build(DataView container)
                        throws InvalidDataException

Description copied from interface: DataBuilder

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.

Specified by:

build in interface DataBuilder<T extends DataSerializable>

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