org.spongepowered.api.data.manipulator.immutable.common

Class AbstractImmutableData<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>

java.lang.Object

org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableData<I,M>

Type Parameters:

I - The immutable data manipulator type

M - The mutable manipulator type

All Implemented Interfaces:

DataSerializable, ImmutableDataManipulator<I,M>, ValueContainer<I>

Direct Known Subclasses:

AbstractImmutableSingleData

public abstract class AbstractImmutableData<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>
extends Object
implements ImmutableDataManipulator<I,M>

An abstract implementation of an ImmutableDataManipulator such that all fields are declared final and remain "immutable".

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImmutableData()

Method Summary

Modifier and Type	Method and Description
I	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
boolean	equals(Object obj)
protected DataContainer	fillContainer(DataContainer dataContainer) Implement this method to add the data to be persisted.
<E> Optional<E>	get(Key<? extends BaseValue<E>> key) Attempts to get the underlying value backed by a BaseValue linked to the provided Key.
Set<Key<?>>	getKeys() Gets all applicable Keys for this ValueContainer.
<E,V extends BaseValue<E>> Optional<V>	getValue(Key<V> key) Gets the BaseValue for the given Key.
Set<ImmutableValue<?>>	getValues() Gets all applicable BaseValues associated with this ValueContainer.
int	hashCode()
protected void	registerFieldGetter(Key<?> key, Supplier<?> function) Simple registration method for the keys to field getter methods.
protected abstract void	registerGetters()
protected void	registerKeyValue(Key<?> key, Supplier<ImmutableValue<?>> function) Simple registration method for the keys to value return methods.
boolean	supports(Key<?> key) Checks if the given Key is supported by this ValueContainer.
DataContainer	toContainer() Serializes this object into a comprehensible DataContainer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, with, with

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

getOrElse, getOrNull, require, supports

Constructor Detail

AbstractImmutableData

protected AbstractImmutableData()

Method Detail

registerKeyValue

protected final void registerKeyValue(Key<?> key,
                                      Supplier<ImmutableValue<?>> function)

Simple registration method for the keys to value return methods.

Note that this is still usable with Java 8 method references. Referencing this::getfoo() is recommended.

Parameters:

key - The key for the value return type

function - The function for getting the value

registerFieldGetter

protected final void registerFieldGetter(Key<?> key,
                                         Supplier<?> function)

Simple registration method for the keys to field getter methods.

Note that this is still usable with Java 8 method references. Referencing this::getfoo() is recommended.

Parameters:

key - The key for the value return type

function - The function for getting the field

registerGetters

protected abstract void registerGetters()

copy

public final I copy()

Description copied from interface: ValueContainer

Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.

Specified by:

copy in interface ImmutableDataManipulator<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>

Specified by:

copy in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Returns:

The new copy

get

public <E> Optional<E> get(Key<? extends BaseValue<E>> key)

Description copied from interface: ValueContainer

Attempts to get the underlying value backed by a BaseValue linked to the provided Key. If the Key is not supported, Optional.empty() is returned. It is important to check for support of a Key by either calling ValueContainer.supports(BaseValue) or ValueContainer.supports(Key).

Specified by:

get in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Type Parameters:

E - The type of value

Parameters:

key - The key linking the

Returns:

The value, if available

getValue

public <E,V extends BaseValue<E>> Optional<V> getValue(Key<V> key)

Description copied from interface: ValueContainer

Gets the BaseValue for the given Key.

Specified by:

getValue in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Type Parameters:

E - The type of the return type

V - The type of value

Parameters:

key - The key linked to the BaseValue

Returns:

The value, if available

supports

public boolean supports(Key<?> key)

Description copied from interface: ValueContainer

Checks if the given Key is supported by this ValueContainer.

Specified by:

supports in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Parameters:

key - The key to check

Returns:

True if the key and value backed by the key is supported

getKeys

public Set<Key<?>> getKeys()

Description copied from interface: ValueContainer

Gets all applicable Keys for this ValueContainer. Changes can not be made to the set to alter the ValueContainer, nor can the BaseValues be changed with the provided ImmutableSet.

Specified by:

getKeys in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Returns:

An immutable set of known Keys

getValues

public Set<ImmutableValue<?>> getValues()

Description copied from interface: ValueContainer

Gets all applicable BaseValues associated with this ValueContainer. As the data backed by the values are copied, any modifications to the BaseValues will not be reflected onto this ValueContainer.

Specified by:

getValues in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Returns:

An immutable set of copied values

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toContainer

public DataContainer toContainer()

Description copied from interface: DataSerializable

Serializes this object into a comprehensible DataContainer.

Specified by:

toContainer in interface DataSerializable

Returns:

A newly created DataContainer

fillContainer

protected DataContainer fillContainer(DataContainer dataContainer)

Implement this method to add the data to be persisted.

Parameters:

dataContainer - The data container

Returns:

The filled data container