org.spongepowered.api.data.manipulator.mutable.common

Class AbstractSingleData<T,M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

java.lang.Object

org.spongepowered.api.data.manipulator.mutable.common.AbstractData<M,I>

org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData<T,M,I>

Type Parameters:

T - The type of single value this will hold

M - The type of DataManipulator

I - The type of ImmutableDataManipulator

All Implemented Interfaces:

DataSerializable, DataManipulator<M,I>, ValueContainer<M>

Direct Known Subclasses:

AbstractBooleanData, AbstractBoundedComparableData, AbstractIntData, AbstractListData, AbstractMappedData, AbstractSingleCatalogData, AbstractSingleEnumData

public abstract class AbstractSingleData<T,M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>
extends AbstractData<M,I>

An abstraction for the various DataManipulators that handle a single value, adding the provided getValue() and setValue(Object) methods for easy manipulation. This as well simplifies handling various other common implementations, such as hashCode() and equals(Object).

Field Summary

Fields

Modifier and Type	Field and Description
protected T	defaultValue
protected Key<? extends BaseValue<T>>	usedKey
protected T	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSingleData(Key<? extends Value<T>> usedKey, T value)
protected	AbstractSingleData(Key<? extends Value<T>> usedKey, T value, T defaultValue)
protected	AbstractSingleData(T value, Key<? extends BaseValue<T>> usedKey) Deprecated. Use AbstractSingleData(Key, Object) instead.

Method Summary

Modifier and Type	Method and Description
abstract I	asImmutable() Gets an ImmutableDataManipulator copy of this DataManipulator such that all backed Values are copied into ImmutableValue counterparts.
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.
protected T	getValue() A simple getter for usage with a Supplier for the AbstractData.registerFieldGetter(Key, Supplier) method.
protected abstract Value<?>	getValueGetter() Gets the Value as a method since this manipulator only focuses on a single value.
int	hashCode()
protected void	registerGettersAndSetters() A required registration method for registering the various fields and value getters.
protected M	setValue(T value) A simple setter for usage with a Consumer for the AbstractData.registerFieldSetter(Key, Consumer) method.
boolean	supports(Key<?> key) Checks if the given Key is supported by this ValueContainer.

Methods inherited from class org.spongepowered.api.data.manipulator.mutable.common.AbstractData

getKeys, getValue, getValues, registerFieldGetter, registerFieldSetter, registerKeyValue, set, toContainer, transform

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.DataManipulator

copy, fill, fill, from, set, set, set

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

getContentVersion

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

getOrElse, getOrNull, require, supports

Field Detail

usedKey

protected final Key<? extends BaseValue<T>> usedKey

defaultValue

protected final T defaultValue

value

protected T value

Constructor Detail

AbstractSingleData

@Deprecated
protected AbstractSingleData(T value,
                                         Key<? extends BaseValue<T>> usedKey)

Deprecated. Use AbstractSingleData(Key, Object) instead.

AbstractSingleData

protected AbstractSingleData(Key<? extends Value<T>> usedKey,
                             T value)

AbstractSingleData

protected AbstractSingleData(Key<? extends Value<T>> usedKey,
                             T value,
                             T defaultValue)

Method Detail

registerGettersAndSetters

protected final void registerGettersAndSetters()

Description copied from class: AbstractData

A required registration method for registering the various fields and value getters. It's suggested that if multiple fields are used, each field can be represented as a Value such that there is an associated Key to "get" that field value.

Specified by:

registerGettersAndSetters in class AbstractData<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

getValueGetter

protected abstract Value<?> getValueGetter()

Gets the Value as a method since this manipulator only focuses on a single value.

Returns:

The constructed value

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<M extends DataManipulator<M,I>>

Overrides:

get in class AbstractData<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

Type Parameters:

E - The type of value

Parameters:

key - The key linking the

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<M extends DataManipulator<M,I>>

Overrides:

supports in class AbstractData<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

Parameters:

key - The key to check

Returns:

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

asImmutable

public abstract I asImmutable()

Description copied from interface: DataManipulator

Gets an ImmutableDataManipulator copy of this DataManipulator such that all backed Values are copied into ImmutableValue counterparts. Any changes to this DataManipulator will NOT be reflected on the returned ImmutableDataManipulator and vice versa.

Returns:

This DataManipulator's data copied into a ImmutableDataManipulator

getValue

protected T getValue()

A simple getter for usage with a Supplier for the AbstractData.registerFieldGetter(Key, Supplier) method.

Returns:

The value

setValue

protected M setValue(T value)

A simple setter for usage with a Consumer for the AbstractData.registerFieldSetter(Key, Consumer) method.

Parameters:

value - The value

Returns:

This manipulator

fillContainer

protected DataContainer fillContainer(DataContainer dataContainer)

Description copied from class: AbstractData

Implement this method to add the data to be persisted.

Overrides:

fillContainer in class AbstractData<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

Parameters:

dataContainer - The data container

Returns:

The filled data container

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractData<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractData<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>