org.spongepowered.api.data.value.immutable

Interface ImmutableListValue<E>

Type Parameters:

E - The type of element of this list value

All Superinterfaces:

BaseValue<List<E>>, ImmutableCollectionValue<E,List<E>,ImmutableListValue<E>,ListValue<E>>, ImmutableValue<List<E>>

All Known Subinterfaces:

ImmutablePatternListValue

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

A type of ImmutableCollectionValue that is backed by a List. All "with" and "Without" methods are returning new instances as every instance is immutable.

Method Summary

Modifier and Type	Method and Description
E	get(int index) Gets the desired element at the desired index.
int	indexOf(E element) Queries for the index of the provided element.
ImmutableListValue<E>	set(int index, E element) Creates a new ImmutableListValue with the desired element at the desired index.
ImmutableListValue<E>	with(int index, E value) Creates a new ImmutableListValue with the specified element at the specified position in the list.
ImmutableListValue<E>	with(int index, Iterable<E> values) Creates a new ImmutableListValue with the specified elements in the order that they are iterated to the list at the specified index.
ImmutableListValue<E>	without(int index) Creates a new ImmutableListValue without the element at the specified index.

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableCollectionValue

asMutable, contains, containsAll, getAll, isEmpty, size, transform, with, withAll, withElement, without, withoutAll, withoutAll

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

exists, get, getDefault, getDirect, getKey

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

with

ImmutableListValue<E> with(int index,
                           E value)

Creates a new ImmutableListValue with 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:

The new value, for chaining

with

ImmutableListValue<E> with(int index,
                           Iterable<E> values)

Creates a new ImmutableListValue with 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:

The new value, for chaining

without

ImmutableListValue<E> without(int index)

Creates a new ImmutableListValue without the element at the specified index. Shifts any subsequent elements to the left, subtracts one from their indices.

Parameters:

index - The index of the element to exclude

Returns:

The new value, for chaining

set

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

Creates a new ImmutableListValue with the desired element at the desired index.

Parameters:

index - The index to replace the element

element - The element to include at the index

Returns:

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