org.openzen.zengarden.collections

Interface ZList<T>

Type Parameters:

T - element type

All Superinterfaces:

java.lang.Iterable<T>, ZCollection<T>

All Known Subinterfaces:

WatchedList<T>

All Known Implementing Classes:

BasicWatchedList, ZArrayList, ZFixedList

public interface ZList<T>
extends ZCollection<T>

Custom alternative to the standard java List.

Method Summary

Modifier and Type	Method and Description
boolean	add(int index, T value) Adds a value at the specified index.
default boolean	contains(T value) Checks if the collection contains the given element.
default ZList<T>	filter(Predicate<T> predicate) Returns a copy of this list, containing all values that match the given filter.
static <T> ZList<T>	fixed(T[] array) Creates an immutable list from the given array.
T	get(int index) Gets the element at the specified index.
int	indexOf(T value) Finds the first index of the given value.
int	lastIndexOf(T value) Finds the last index of the given value.
default <U> ZList<U>	map(java.lang.Class<U> type, Function<T,U> converter) Returns a copy of this list, containing all original values converted with the given function.
T	remove(int index) Removes the element at the specified index.
T	set(int index, T value) Sets the index at the specified index.
default WatchedList<T>	watch() Creates a watched list, which allows event listeners to be registered whenever the list has been modified.

Methods inherited from interface org.openzen.zengarden.collections.ZCollection

add, addAll, clear, containsAll, getElementClass, isEmpty, mapLive, mapLive, reduce, remove, removeAll, size, toArray

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

fixed

static <T> ZList<T> fixed(T[] array)

Creates an immutable list from the given array. The resulting list instance cannot be modified.

Type Parameters:

T - element type

Parameters:

array - array to wrap

Returns:

immutable list

add

boolean add(int index,
            T value)

Adds a value at the specified index.

Parameters:

index - index to add at

value - value to add

Returns:

true if the collection has been changed

remove

T remove(int index)

Removes the element at the specified index. Returns the element that was at that position.

Parameters:

index - index to remove at

Returns:

removed element

get

T get(int index)

Gets the element at the specified index.

Parameters:

index - index to retrieve

Returns:

element at that index

set

T set(int index,
      T value)

Sets the index at the specified index.

Parameters:

index - index to set at

value - new value

Returns:

old value at that index

indexOf

int indexOf(T value)

Finds the first index of the given value. Returns -1 if the value could not be found.

Parameters:

value - value to find

Returns:

first index of the given value, or -1

lastIndexOf

int lastIndexOf(T value)

Finds the last index of the given value. Returns -1 if the value could not be found.

Parameters:

value - value to find

Returns:

last index of the given vlue, or -1

map

default <U> ZList<U> map(java.lang.Class<U> type,
                         Function<T,U> converter)

Returns a copy of this list, containing all original values converted with the given function.

Specified by:

map in interface ZCollection<T>

Type Parameters:

U - resulting element type

Parameters:

type - element class

converter - conversion function

Returns:

collection copy

filter

default ZList<T> filter(Predicate<T> predicate)

Returns a copy of this list, containing all values that match the given filter.

Specified by:

filter in interface ZCollection<T>

Parameters:

predicate - predicate to use

Returns:

filtered collection

contains

default boolean contains(T value)

Description copied from interface: ZCollection

Checks if the collection contains the given element.

Specified by:

contains in interface ZCollection<T>

Parameters:

value - value to check the collection for

Returns:

true if the element is in the collection, false otherwise

watch

default WatchedList<T> watch()

Creates a watched list, which allows event listeners to be registered whenever the list has been modified.

Returns:

watched list