org.spongepowered.api.data.value.mutable

Interface ListValue<E>

Type Parameters:

E - The type of element of this list value

All Superinterfaces:

BaseValue<List<E>>, CollectionValue<E,List<E>,ListValue<E>,ImmutableListValue<E>>, Iterable<E>, Value<List<E>>

All Known Subinterfaces:

PatternListValue

public interface ListValue<E>
extends CollectionValue<E,List<E>,ListValue<E>,ImmutableListValue<E>>

A type of CollectionValue that is backed by a List. All mutator methods provided are similar to those existing in List with the difference of returning itself, for fluency.

Method Summary

Modifier and Type	Method and Description
ListValue<E>	add(int index, E value) Adds the specified element at the specified position in the list.
ListValue<E>	add(int index, Iterable<E> values) Adds the specified elements in the order that they are iterated to the list at the specified index.
E	get(int index) Gets the desired element at the desired index.
int	indexOf(E element) Queries for the index of the provided element.
ListValue<E>	remove(int index) Removes the element at the specified position in this list (optional operation).
ListValue<E>	set(int index, E element) Replaces the element at the specified index in this list with the specified element.

Methods inherited from interface org.spongepowered.api.data.value.mutable.CollectionValue

add, addAll, asImmutable, contains, containsAll, copy, filter, getAll, isEmpty, remove, removeAll, removeAll, set, size, transform

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

exists, get, getDefault, getDirect, getKey

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

E get(int index)

Gets the desired element at the desired index.

Parameters:

index - The index of the element to return

Returns:

The element at the desired index

Throws:

IndexOutOfBoundsException - if the index is out of range

add

ListValue<E> add(int index,
                 E value)

Adds the specified element at the specified position in the list. As well, the element at the provided index is shifted to the right, increasing its and the elements thereafter their indices by one.

Parameters:

index - The index to add the provided element at

value - The element to add

Returns:

This value, for chaining

add

ListValue<E> add(int index,
                 Iterable<E> values)

Adds the specified elements in the order that they are iterated to the list at the specified index. The element at the provided index and elements thereafter are shifted to the right, increasing their indices by one.

Parameters:

index - The index to add the elements at

values - The elements to add

Returns:

This value, for chaining

remove

ListValue<E> remove(int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left, subtracts one from their indices.

Parameters:

index - The index of the element to remove

Returns:

This value, for chaining

set

ListValue<E> set(int index,
                 E element)

Replaces the element at the specified index in this list with the specified element.

Parameters:

index - The index to replace the element with

element - The element to set

Returns:

This value, for chaining

indexOf

int indexOf(E element)

Queries for the index of the provided element. If the element is not contained in this list, -1 is returned.

Parameters:

element - The element to get the index from

Returns:

The index of the element, -1 if not available