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

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

java.lang.Object

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

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

Type Parameters:

T - The type of value

I - The type of immutable manipulator

M - The type of mutable manipulator

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractImmutableBooleanData, AbstractImmutableBoundedComparableData, AbstractImmutableListData, AbstractImmutableMappedData, AbstractImmutableSingleCatalogData, AbstractImmutableSingleEnumData

public abstract class AbstractImmutableSingleData<T,I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>
extends AbstractImmutableData<I,M>

An abstract implementation of an ImmutableDataManipulator that specifically deals with a single value.

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	AbstractImmutableSingleData(Key<? extends Value<T>> usedKey, T value)
protected	AbstractImmutableSingleData(Key<? extends Value<T>> usedKey, T value, T defaultValue)
protected	AbstractImmutableSingleData(T value, Key<? extends BaseValue<T>> usedKey) Deprecated. Use AbstractImmutableSingleData(Key, Object) instead.

Method Summary

Modifier and Type	Method and Description
abstract M	asMutable() Gets a DataManipulator copy of this ImmutableDataManipulator such that all backed ImmutableValues are copied into their Value counterparts.
boolean	equals(Object obj)
<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.
protected T	getValue()
protected abstract ImmutableValue<?>	getValueGetter()
int	hashCode()
protected void	registerGetters()
boolean	supports(Key<?> key) Checks if the given Key is supported by this ValueContainer.

Methods inherited from class org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableData

copy, fillContainer, getValue, getValues, registerFieldGetter, registerKeyValue, toContainer

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

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

Field Detail

usedKey

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

value

protected final T value

defaultValue

protected final T defaultValue

Constructor Detail

AbstractImmutableSingleData

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

Deprecated. Use AbstractImmutableSingleData(Key, Object) instead.

AbstractImmutableSingleData

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

AbstractImmutableSingleData

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

Method Detail

getValueGetter

protected abstract ImmutableValue<?> getValueGetter()

getValue

protected final T getValue()

asMutable

public abstract M asMutable()

Description copied from interface: ImmutableDataManipulator

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

Returns:

This ImmutableDataManipulator's data copied into a DataManipulator

registerGetters

protected final void registerGetters()

Specified by:

registerGetters in class AbstractImmutableData<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>

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

Overrides:

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

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

Overrides:

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

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

Overrides:

getKeys in class AbstractImmutableData<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>

Returns:

An immutable set of known Keys

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(Object obj)

Overrides:

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