com.livescribe.ext.util
Interface List

All Superinterfaces:

Collection

All Known Implementing Classes:

LinkedList

public interface List
extends Collection

Method Summary

void	add(int index, Object element)
boolean	add(Object o)
boolean	addAll(Collection c)
boolean	addAll(int index, Collection c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection c)
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
Object	get(int index)
int	hashCode() Returns a hash code value for the object.
int	indexOf(Object o)
boolean	isEmpty()
Iterator	iterator()
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(int index)
Object	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection c)
boolean	retainAll(Collection c)
Object	set(int index, Object element)
int	size()
List	subList(int fromIndex, int toIndex)
Object[]	toArray()

Method Detail

add

void add(int index,
         Object element)

add

boolean add(Object o)

Specified by:

add in interface Collection

addAll

boolean addAll(Collection c)

Specified by:

addAll in interface Collection

addAll

boolean addAll(int index,
               Collection c)
               throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

clear

void clear()

Specified by:

clear in interface Collection

contains

boolean contains(Object o)

Specified by:

contains in interface Collection

containsAll

boolean containsAll(Collection c)
                    throws NullPointerException

Specified by:

containsAll in interface Collection

Throws:

NullPointerException

equals

boolean equals(Object o)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Specified by:

equals in interface Collection

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

get

Object get(int index)
           throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

hashCode

int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Specified by:

hashCode in interface Collection

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

indexOf

int indexOf(Object o)

isEmpty

boolean isEmpty()

Specified by:

isEmpty in interface Collection

iterator

Iterator iterator()

Specified by:

iterator in interface Collection

lastIndexOf

int lastIndexOf(Object o)

listIterator

ListIterator listIterator()

listIterator

ListIterator listIterator(int index)
                          throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

remove

Object remove(int index)

remove

boolean remove(Object o)

Specified by:

remove in interface Collection

removeAll

boolean removeAll(Collection c)
                  throws NullPointerException

Specified by:

removeAll in interface Collection

Throws:

NullPointerException

retainAll

boolean retainAll(Collection c)
                  throws NullPointerException

Specified by:

retainAll in interface Collection

Throws:

NullPointerException

set

Object set(int index,
           Object element)
           throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

size

int size()

Specified by:

size in interface Collection

subList

List subList(int fromIndex,
             int toIndex)
             throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

toArray

Object[] toArray()

Specified by:

toArray in interface Collection