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

Class AbstractListData<E,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

java.lang.Object

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

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

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

Type Parameters:

E - The type of element within the list

M - The type of DataManipulator

I - The type of ImmutableDataManipulator

All Implemented Interfaces:

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

public abstract class AbstractListData<E,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>
extends AbstractSingleData<List<E>,M,I>
implements ListData<E,M,I>

A common implementation for ListDatas provided by the API.

Field Summary

Fields inherited from class org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData

defaultValue, usedKey, value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractListData(Key<ListValue<E>> usedKey, List<E> value)
protected	AbstractListData(Key<ListValue<E>> usedKey, List<E> value, List<E> defaultValue)
protected	AbstractListData(List<E> value, Key<? extends BaseValue<List<E>>> usedKey) Deprecated. Use AbstractListData(Key, List) 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.
List<E>	asList() Gets the List value itself from this manipulator.
boolean	equals(Object obj)
<V> Optional<V>	get(Key<? extends BaseValue<V>> key) Attempts to get the underlying value backed by a BaseValue linked to the provided Key.
ListValue<E>	getListValue() Gets the ListValue of this ListData.
protected List<E>	getValue() A simple getter for usage with a Supplier for the AbstractData.registerFieldGetter(Key, Supplier) method.
protected ListValue<E>	getValueGetter() Gets the Value as a method since this manipulator only focuses on a single value.
int	hashCode()
protected M	setValue(List<E> 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.AbstractSingleData

fillContainer, registerGettersAndSetters

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.mutable.ListData

addElement, addElement, addElements, contains, get, remove, remove, removeAll, removeAll, setElement, setElements

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

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

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

getContentVersion, toContainer

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

getKeys, getOrElse, getOrNull, getValue, getValues, require, supports

Constructor Detail

AbstractListData

@Deprecated
protected AbstractListData(List<E> value,
                                       Key<? extends BaseValue<List<E>>> usedKey)

Deprecated. Use AbstractListData(Key, List) instead.

AbstractListData

protected AbstractListData(Key<ListValue<E>> usedKey,
                           List<E> value)

AbstractListData

protected AbstractListData(Key<ListValue<E>> usedKey,
                           List<E> value,
                           List<E> defaultValue)

Method Detail

getValueGetter

protected ListValue<E> getValueGetter()

Description copied from class: AbstractSingleData

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

Specified by:

getValueGetter in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Returns:

The constructed value

get

public <V> Optional<V> get(Key<? extends BaseValue<V>> 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 ListData<E,M,I>>

Overrides:

get in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Type Parameters:

V - 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 ListData<E,M,I>>

Overrides:

supports in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,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.

Specified by:

asImmutable in interface DataManipulator<M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Specified by:

asImmutable in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Returns:

This DataManipulator's data copied into a ImmutableDataManipulator

getValue

protected List<E> getValue()

Description copied from class: AbstractSingleData

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

Overrides:

getValue in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Returns:

The value

setValue

protected M setValue(List<E> value)

Description copied from class: AbstractSingleData

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

Overrides:

setValue in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Parameters:

value - The value

Returns:

This manipulator

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSingleData<List<E>,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

getListValue

public ListValue<E> getListValue()

Description copied from interface: ListData

Gets the ListValue of this ListData.

Specified by:

getListValue in interface ListData<E,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Returns:

The underlying list value

asList

public List<E> asList()

Description copied from interface: ListData

Gets the List value itself from this manipulator.

Specified by:

asList in interface ListData<E,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

Returns:

The underlying list value as a list

See Also:

ListValue