org.openzen.zengarden.collections

Class ZFixedList<T>

java.lang.Object

org.openzen.zengarden.collections.ZFixedList<T>

Type Parameters:

T - element type

All Implemented Interfaces:

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

public class ZFixedList<T>
extends java.lang.Object
implements ZList<T>

Immutable implementation of a ZList, backed by an array. Note that the list can still be modified by modifying the backing array directly.

Constructor Summary

Constructors

Constructor and Description
ZFixedList(T[] contents)

Method Summary

Modifier and Type	Method and Description
boolean	add(int index, T value) Adds a value at the specified index.
boolean	add(T value) Adds an element to the collection.
void	clear() Removes all elements from this collection.
boolean	contains(T value) Checks if the collection contains the given element.
T	get(int index) Gets the element at the specified index.
java.lang.Class<T>	getElementClass() Returns the collection's element class.
int	indexOf(T value) Finds the first index of the given value.
java.util.Iterator<T>	iterator()
int	lastIndexOf(T value) Finds the last index of the given value.
T	remove(int index) Removes the element at the specified index.
boolean	remove(T value) Removes an element from the collection.
T	set(int index, T value) Sets the index at the specified index.
int	size() Returns the size of this collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

filter, fixed, map, watch

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

addAll, containsAll, isEmpty, mapLive, mapLive, reduce, removeAll, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ZFixedList

public ZFixedList(T[] contents)

Method Detail

add

public boolean add(int index,
                   T value)

Description copied from interface: ZList

Adds a value at the specified index.

Specified by:

add in interface ZList<T>

Parameters:

index - index to add at

value - value to add

Returns:

true if the collection has been changed

remove

public T remove(int index)

Description copied from interface: ZList

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

Specified by:

remove in interface ZList<T>

Parameters:

index - index to remove at

Returns:

removed element

get

public T get(int index)

Description copied from interface: ZList

Gets the element at the specified index.

Specified by:

get in interface ZList<T>

Parameters:

index - index to retrieve

Returns:

element at that index

set

public T set(int index,
             T value)

Description copied from interface: ZList

Sets the index at the specified index.

Specified by:

set in interface ZList<T>

Parameters:

index - index to set at

value - new value

Returns:

old value at that index

indexOf

public int indexOf(T value)

Description copied from interface: ZList

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

Specified by:

indexOf in interface ZList<T>

Parameters:

value - value to find

Returns:

first index of the given value, or -1

lastIndexOf

public int lastIndexOf(T value)

Description copied from interface: ZList

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

Specified by:

lastIndexOf in interface ZList<T>

Parameters:

value - value to find

Returns:

last index of the given vlue, or -1

getElementClass

public java.lang.Class<T> getElementClass()

Description copied from interface: ZCollection

Returns the collection's element class.

Specified by:

getElementClass in interface ZCollection<T>

Returns:

element class

add

public boolean add(T value)

Description copied from interface: ZCollection

Adds an element to the collection.

Specified by:

add in interface ZCollection<T>

Parameters:

value - value to be added

Returns:

true if the collection has been modified

remove

public boolean remove(T value)

Description copied from interface: ZCollection

Removes an element from the collection. Does nothing if the collection doesn't contain the given element.

Specified by:

remove in interface ZCollection<T>

Parameters:

value - value to be removed

Returns:

true if the collection has been modified, false otherwise

contains

public boolean contains(T value)

Description copied from interface: ZCollection

Checks if the collection contains the given element.

Specified by:

contains in interface ZCollection<T>

Specified by:

contains in interface ZList<T>

Parameters:

value - value to check the collection for

Returns:

true if the element is in the collection, false otherwise

size

public int size()

Description copied from interface: ZCollection

Returns the size of this collection.

Specified by:

size in interface ZCollection<T>

Returns:

collection size

clear

public void clear()

Description copied from interface: ZCollection

Removes all elements from this collection.

Specified by:

clear in interface ZCollection<T>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>