org.spongepowered.api.data.manipulator.mutable

Interface ListData<E,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>

All Superinterfaces:

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

All Known Subinterfaces:

EnchantmentData, FireworkEffectData, LoreData, PagedData, PassengerData, PlainPagedData, PotionEffectData, SignData, StoredEnchantmentData, TradeOfferData

All Known Implementing Classes:

AbstractListData

public interface ListData<E,M extends ListData<E,M,I>,I extends ImmutableListData<E,I,M>>
extends DataManipulator<M,I>

Method Summary

Modifier and Type	Method and Description
default M	addElement(E element) Appends the provided element at the end of the underlying List.
default M	addElement(int index, E element) Inserts the specified element at the specified position in this list.
default M	addElements(Iterable<E> elements) Appends the provided E elements to the end of the internal list of elements.
List<E>	asList() Gets the List value itself from this manipulator.
default boolean	contains(E element) Returns whether the underlying List contains the provided element.
default Optional<E>	get(int index) Gets an element of type E by the provided index.
ListValue<E>	getListValue() Gets the ListValue of this ListData.
default M	remove(E element) Removes the desired element from the underlying List.
default M	remove(int index) Removes the desired element from the desired index.
default M	removeAll(Iterable<E> elements) Removes all of the provided elements from the underlying List.
default M	removeAll(Predicate<E> predicate) Removes any and all elements that match true to the provided Predicate from the underlying List.
default M	setElement(int index, E element) Replaces the element at the specified position in this list with the specified element (optional operation).
default M	setElements(List<E> elements) Replaces the underlying list of elements with the provided List of elements.

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

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

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

Method Detail

getListValue

ListValue<E> getListValue()

Gets the ListValue of this ListData.

Returns:

The underlying list value

asList

List<E> asList()

Gets the List value itself from this manipulator.

Returns:

The underlying list value as a list

See Also:

ListValue

get

default Optional<E> get(int index)

Gets an element of type E by the provided index.

Parameters:

index - The index to get the value at

Returns:

The object at the provided index, if available

See Also:

List.get(int)

contains

default boolean contains(E element)

Returns whether the underlying List contains the provided element.

Parameters:

element - The element to check

Returns:

True if the element is contained in the underlying list

See Also:

List.contains(Object)

setElement

default M setElement(int index,
                     E element)

Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters:

index - The index to set the element to

element - The element to set at the index

Returns:

This manipulator, for chaining

See Also:

List.set(int, Object)

setElements

default M setElements(List<E> elements)

Replaces the underlying list of elements with the provided List of elements.

Parameters:

elements - The element to set at the index

Returns:

This manipulator, for chaining

See Also:

List.set(int, Object)

addElement

default M addElement(E element)

Appends the provided element at the end of the underlying List.

Parameters:

element - The element to append

Returns:

This manipulator, for chaining

See Also:

List.add(Object)

addElement

default M addElement(int index,
                     E element)

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:

index - The index of the element

element - The element to add

Returns:

This manipulator, for chaining

See Also:

List.add(int, Object)

addElements

default M addElements(Iterable<E> elements)

Appends the provided E elements to the end of the internal list of elements.

Parameters:

elements - The elements to add

Returns:

This manipulator, for chaining

See Also:

List.addAll(Collection)

remove

default M remove(int index)

Removes the desired element from the desired index.

Parameters:

index - The index to remove an element from

Returns:

This manipulator, for chaining

See Also:

List.remove(int)

remove

default M remove(E element)

Removes the desired element from the underlying List.

Parameters:

element - The element to remove

Returns:

This manipulator, for chaining

See Also:

List.remove(Object)

removeAll

default M removeAll(Iterable<E> elements)

Removes all of the provided elements from the underlying List.

Parameters:

elements - The elements to remove

Returns:

This manipulator, for chaining

See Also:

List.removeAll(Collection)

removeAll

default M removeAll(Predicate<E> predicate)

Removes any and all elements that match true to the provided Predicate from the underlying List.

Parameters:

predicate - The predicate to filter elements from

Returns:

This manipulator, for chaining

See Also:

Collection.removeIf(Predicate)