org.spongepowered.api.data.manipulator.immutable

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

Type Parameters:

E - The type of elements contained in the underlying list

I - The immutable data variant

M - The mutable data variant

All Superinterfaces:

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

All Known Subinterfaces:

ImmutableEnchantmentData, ImmutableFireworkEffectData, ImmutableLoreData, ImmutablePagedData, ImmutablePassengerData, ImmutablePlainPagedData, ImmutablePotionEffectData, ImmutableSignData, ImmutableStoredEnchantmentData, ImmutableTradeOfferData

All Known Implementing Classes:

AbstractImmutableListData

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

An immutable variant of ListData that can be queried, but not changed or mutated.

Method Summary

Modifier and Type	Method and Description
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.
ImmutableListValue<E>	getListValue() Gets the ImmutableListValue of this ImmutableListData.

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

asMutable, copy, with, with

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

ImmutableListValue<E> getListValue()

Gets the ImmutableListValue of this ImmutableListData.

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:

ImmutableListValue

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)