org.apache.pivot.collections
Class EnumList<E extends Enum<E>>

java.lang.Object
  org.apache.pivot.collections.EnumList<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, List<E>, Sequence<E>

public class EnumList<E extends Enum<E>>
extends Object
implements List<E>, Serializable

Implementation of the List interface that is backed by an enum.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.List

List.ListListenerList<T>

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

EnumList(Class<E> enumClass)

Method Summary

int	add(E item) Adds an item to the list.
void	clear() Removes all elements from the collection.
boolean	equals(Object o)
E	get(int index) Retrieves the item at the given index.
Comparator<E>	getComparator() Returns the collection's sort order.
Class<E>	getEnumClass()
int	getLength() Returns the length of the list.
ListenerList<ListListener<E>>	getListListeners() Returns the list listener list.
int	hashCode()
int	indexOf(E item) Returns the index of an item in the sequence.
void	insert(E item, int index) Inserts an item into the list.
boolean	isEmpty() Tests the emptiness of the collection.
Iterator<E>	iterator()
int	remove(E item) Removes the first occurrence of the given item from the sequence.
Sequence<E>	remove(int index, int count) Removes one or more items from the sequence.
void	setComparator(Comparator<E> comparator) Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.
E[]	toArray()
String	toString()
E	update(int index, E item) Updates the item at the given index.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumList

public EnumList(Class<E> enumClass)

Method Detail

getEnumClass

public Class<E> getEnumClass()

add

public int add(E item)

Description copied from interface: List

Adds an item to the list. If the list is unsorted, the item is appended to the end of the list. Otherwise, it is inserted at the appropriate index.

Specified by:

add in interface List<E extends Enum<E>>

Specified by:

add in interface Sequence<E extends Enum<E>>

Parameters:

item - The item to be added to the sequence.

Returns:

The index at which the item was added.

See Also:

ListListener.itemInserted(List, int)

insert

public void insert(E item,
                   int index)

Description copied from interface: List

Inserts an item into the list.

Specified by:

insert in interface List<E extends Enum<E>>

Specified by:

insert in interface Sequence<E extends Enum<E>>

Parameters:

item - The item to be added to the list.

index - The index at which the item should be inserted. Must be a value between 0 and getLength().

See Also:

ListListener.itemInserted(List, int)

update

public E update(int index,
                E item)

Description copied from interface: List

Updates the item at the given index.

Specified by:

update in interface List<E extends Enum<E>>

Specified by:

update in interface Sequence<E extends Enum<E>>

Parameters:

index - The index of the item to update.

item - The item that will replace any existing value at the given index.

Returns:

The item that was previously stored at the given index.

See Also:

ListListener.itemUpdated(List, int, Object)

remove

public int remove(E item)

Description copied from interface: Sequence

Removes the first occurrence of the given item from the sequence.

Specified by:

remove in interface Sequence<E extends Enum<E>>

Parameters:

item - The item to remove.

Returns:

The index of the item that was removed, or -1 if the item could not be found.

See Also:

Sequence.remove(int, int)

remove

public Sequence<E> remove(int index,
                          int count)

Description copied from interface: Sequence

Removes one or more items from the sequence.

Specified by:

remove in interface List<E extends Enum<E>>

Specified by:

remove in interface Sequence<E extends Enum<E>>

Parameters:

index - The starting index to remove.

count - The number of items to remove, beginning with index.

Returns:

A sequence containing the items that were removed.

See Also:

ListListener.itemsRemoved(List, int, Sequence)

clear

public void clear()

Description copied from interface: Collection

Removes all elements from the collection.

Specified by:

clear in interface Collection<E extends Enum<E>>

Specified by:

clear in interface List<E extends Enum<E>>

See Also:

ListListener.itemsRemoved(List, int, Sequence)

get

public E get(int index)

Description copied from interface: Sequence

Retrieves the item at the given index.

Specified by:

get in interface Sequence<E extends Enum<E>>

Parameters:

index - The index of the item to retrieve.

indexOf

public int indexOf(E item)

Description copied from interface: Sequence

Returns the index of an item in the sequence.

Specified by:

indexOf in interface Sequence<E extends Enum<E>>

Parameters:

item - The item to locate.

Returns:

The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

isEmpty

public boolean isEmpty()

Description copied from interface: Collection

Tests the emptiness of the collection.

Specified by:

isEmpty in interface Collection<E extends Enum<E>>

Returns:

true if the collection contains no elements; false, otherwise.

getLength

public int getLength()

Description copied from interface: List

Returns the length of the list.

Specified by:

getLength in interface List<E extends Enum<E>>

Specified by:

getLength in interface Sequence<E extends Enum<E>>

Returns:

The number of items in the list, or -1 if the list's length is not known. In this case, the iterator must be used to retrieve the contents of the list.

toArray

public E[] toArray()

getComparator

public Comparator<E> getComparator()

Description copied from interface: Collection

Returns the collection's sort order.

Specified by:

getComparator in interface Collection<E extends Enum<E>>

Returns:

The comparator used to order elements in the collection, or null if the sort order is undefined.

See Also:

Collection.setComparator(Comparator)

setComparator

public void setComparator(Comparator<E> comparator)

Description copied from interface: Collection

Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

Calling this method more than once with the same comparator will re-sort the collection.

Specified by:

setComparator in interface Collection<E extends Enum<E>>

Specified by:

setComparator in interface List<E extends Enum<E>>

Parameters:

comparator - The comparator used to order elements in the collection, or null if the collection is unsorted.

See Also:

ListListener.comparatorChanged(List, Comparator)

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends Enum<E>>

getListListeners

public ListenerList<ListListener<E>> getListListeners()

Description copied from interface: List

Returns the list listener list.

Specified by:

getListListeners in interface List<E extends Enum<E>>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object