edu.emory.mathcs.util.collections.ints
Interface IntList

All Superinterfaces:
IntCollection
All Known Implementing Classes:
IntArrayList

public interface IntList
extends IntCollection

List of int numbers.

Version:
1.0
Author:
Dawid Kurzyniec

Method Summary
 boolean add(int e)
          Attempts to add the specified number to this collection.
 boolean addAll(IntCollection c)
          Attempts to add to this collection all the numbers contained in the specified collection.
 boolean addAll(int index, IntCollection c)
           
 void addAt(int index, int e)
          Adds the value at the specified index, and moves elements starting at index to the right.
 void clear()
          Removes all the numbers from this collection.
 boolean contains(int e)
          Returns true if this collection contains specified number; false otherwise.
 boolean containsAll(IntCollection c)
          Returns true if this collection contains all the numbers from collection c; false otherwise.
 boolean equals(java.lang.Object o)
           
 int getAt(int index)
          Returns the value at the specified index.
 int hashCode()
           
 int indexOf(int e)
          Returns the smallest index at which the list contains the specified number.
 boolean isEmpty()
          Returns true if this collection is empty; false otherwise.
 IntIterator iterator()
          Returns the iterator over numbers contained in this collection.
 int lastIndexOf(int e)
          Returns the largest index at which the list contains the specified number.
 IntListIterator listIterator()
           
 IntListIterator listIterator(int index)
           
 boolean remove(int e)
          Attempts to remove the specified number from this collection.
 boolean removeAll(IntCollection c)
          Attempts to remove from this collection all the numbers contained in the specified collection.
 int removeAt(int index)
          Removes the value at the specified index, and shifts elements starting at index+1 to the left.
 boolean retainAll(IntCollection c)
          Attempts to remove from this collection all the numbers not contained in the specified collection.
 int setAt(int index, int e)
          Sets the value at the specified index.
 int size()
          Returns the number of elements in this collection.
 IntList subList(int fromIndex, int toIndex)
           
 int[] toArray()
          Returns the newly allocated array containing all numbers from this collection, in the order returned by its iterator.
 int[] toArray(int[] a)
          Returns an array containing all of the numbers in this collection.
 
Methods inherited from interface edu.emory.mathcs.util.collections.ints.IntCollection
size64
 

Method Detail

size

public int size()
Description copied from interface: IntCollection
Returns the number of elements in this collection. If exceeds Integer.MAX_VALUE, then Integer.MAX_VALUE is returned.

Specified by:
size in interface IntCollection

isEmpty

public boolean isEmpty()
Description copied from interface: IntCollection
Returns true if this collection is empty; false otherwise.

Specified by:
isEmpty in interface IntCollection
Returns:
true if this collection is empty; false otherwise

contains

public boolean contains(int e)
Description copied from interface: IntCollection
Returns true if this collection contains specified number; false otherwise.

Specified by:
contains in interface IntCollection
Returns:
true if this collection contains specified number; false otherwise

iterator

public IntIterator iterator()
Description copied from interface: IntCollection
Returns the iterator over numbers contained in this collection.

Specified by:
iterator in interface IntCollection
Returns:
the iterator over numbers contained in this collection.

toArray

public int[] toArray()
Description copied from interface: IntCollection
Returns the newly allocated array containing all numbers from this collection, in the order returned by its iterator.

Specified by:
toArray in interface IntCollection
Returns:
the array containing all numbers from this collection

toArray

public int[] toArray(int[] a)
Description copied from interface: IntCollection
Returns an array containing all of the numbers in this collection. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated.

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the IntCollection.toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method may, under certain circumstances, be used to save allocation costs.

Specified by:
toArray in interface IntCollection
Parameters:
a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose.
Returns:
an array containing all the elements in this collection

add

public boolean add(int e)
Description copied from interface: IntCollection
Attempts to add the specified number to this collection. Returns true if the collection was modified as a result of this call; false otherwise.

Specified by:
add in interface IntCollection
Parameters:
e - number to be added to this collection
Returns:
true if this collection was modified as a result of this call

remove

public boolean remove(int e)
Description copied from interface: IntCollection
Attempts to remove the specified number from this collection. Returns true if the collection was modified as a result of this call; false otherwise.

Specified by:
remove in interface IntCollection
Parameters:
e - number to be removed from this collection
Returns:
true if this collection was modified as a result of this call

containsAll

public boolean containsAll(IntCollection c)
Description copied from interface: IntCollection
Returns true if this collection contains all the numbers from collection c; false otherwise.

Specified by:
containsAll in interface IntCollection
Returns:
true if this collection contains all numbers from c; false otherwise

addAll

public boolean addAll(IntCollection c)
Description copied from interface: IntCollection
Attempts to add to this collection all the numbers contained in the specified collection. Returns true if the collection was modified as a result of this call; false otherwise.

Specified by:
addAll in interface IntCollection
Parameters:
c - a collection of numbers to be added to this collection
Returns:
true if this collection was modified as a result of this call

addAll

public boolean addAll(int index,
                      IntCollection c)

removeAll

public boolean removeAll(IntCollection c)
Description copied from interface: IntCollection
Attempts to remove from this collection all the numbers contained in the specified collection. Returns true if the collection was modified as a result of this call; false otherwise.

Specified by:
removeAll in interface IntCollection
Parameters:
c - a collection of numbers to be removed from this collection
Returns:
true if this collection was modified as a result of this call

retainAll

public boolean retainAll(IntCollection c)
Description copied from interface: IntCollection
Attempts to remove from this collection all the numbers not contained in the specified collection. Returns true if the collection was modified as a result of this call; false otherwise.

Specified by:
retainAll in interface IntCollection
Parameters:
c - a collection of numbers to be retained in this collection
Returns:
true if this collection was modified as a result of this call

clear

public void clear()
Description copied from interface: IntCollection
Removes all the numbers from this collection.

Specified by:
clear in interface IntCollection

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface IntCollection

hashCode

public int hashCode()
Specified by:
hashCode in interface IntCollection

getAt

public int getAt(int index)
Returns the value at the specified index.

Parameters:
index - the index to retrieve the value from.
Returns:
the value at the specified index.
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 or index >= size.

setAt

public int setAt(int index,
                 int e)
Sets the value at the specified index.

Parameters:
index - the index to set the value at.
e - the new value.
Returns:
the value previously present the specified index.
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 or index >= size.

addAt

public void addAt(int index,
                  int e)
Adds the value at the specified index, and moves elements starting at index to the right.

Parameters:
index - the index to add the value at.
e - the new value.
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 or index > size.

removeAt

public int removeAt(int index)
Removes the value at the specified index, and shifts elements starting at index+1 to the left.

Parameters:
index - the index to remove the value from.
Returns:
the value previously present at the specified index.
Throws:
java.lang.IndexOutOfBoundsException - if index < 0 or index >= size.

indexOf

public int indexOf(int e)
Returns the smallest index at which the list contains the specified number.

Parameters:
e - the number to look for
Returns:
the smallest index of e

lastIndexOf

public int lastIndexOf(int e)
Returns the largest index at which the list contains the specified number.

Parameters:
e - the number to look for
Returns:
the largest index of e

listIterator

public IntListIterator listIterator()

listIterator

public IntListIterator listIterator(int index)

subList

public IntList subList(int fromIndex,
                       int toIndex)