org.apache.commons.collections.primitives.decorators
Class UnmodifiableIntList

java.lang.Object
  |
  +--org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection
        |
        +--org.apache.commons.collections.primitives.decorators.BaseProxyIntList
              |
              +--org.apache.commons.collections.primitives.decorators.BaseUnmodifiableIntList
                    |
                    +--org.apache.commons.collections.primitives.decorators.UnmodifiableIntList

All Implemented Interfaces:

IntCollection, IntList, Serializable

public final class UnmodifiableIntList

extends org.apache.commons.collections.primitives.decorators.BaseUnmodifiableIntList

implements Serializable

Since:

Commons Primitives 1.0

Version:

$Revision: 1.3 $ $Date: 2003/10/16 20:49:38 $

See Also:

Serialized Form

Method Summary

boolean	add(int element) Appends the specified element to the end of me (optional operation).
void	add(int index, int element) Inserts the specified element at the specified position (optional operation).
boolean	addAll(org.apache.commons.collections.primitives.IntCollection c) Adds all of the elements in the specified collection to me (optional operation).
boolean	addAll(int index, org.apache.commons.collections.primitives.IntCollection collection) Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
void	clear() Removes all my elements (optional operation).
boolean	contains(int element) Returns true iff I contain the specified element.
boolean	containsAll(org.apache.commons.collections.primitives.IntCollection c) Returns true iff I contain all of the elements in the given collection.
boolean	equals(Object obj) Returns true iff that is an IntList that contains the same elements in the same order as me.
int	get(int index) Returns the value of the element at the specified position within me.
int	hashCode() Returns my hash code.
int	indexOf(int element) Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.
boolean	isEmpty() Returns true iff I contain no elements.
org.apache.commons.collections.primitives.IntIterator	iterator() Returns an iterator over all my elements, in the appropriate sequence.
int	lastIndexOf(int element) Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.
org.apache.commons.collections.primitives.IntListIterator	listIterator() Returns a bidirectional iterator over all my elements, in the appropriate sequence.
org.apache.commons.collections.primitives.IntListIterator	listIterator(int index) Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position.
boolean	removeAll(org.apache.commons.collections.primitives.IntCollection c) Removes all of my elements that are contained in the specified collection (optional operation).
boolean	removeElement(int element) Removes a single occurrence of the specified element (optional operation).
int	removeElementAt(int index) Removes the element at the specified position in (optional operation).
boolean	retainAll(org.apache.commons.collections.primitives.IntCollection c) Removes all of my elements that are not contained in the specified collection (optional operation).
int	set(int index, int element) Replaces the element at the specified position in me with the specified element (optional operation).
int	size() Returns the number of elements I contain.
org.apache.commons.collections.primitives.IntList	subList(int fromIndex, int toIndex) Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
int[]	toArray() Returns an array containing all of my elements.
int[]	toArray(int[] a) Returns an array containing all of my elements, using the given array if it is large enough.
String	toString()
static org.apache.commons.collections.primitives.IntList	wrap(org.apache.commons.collections.primitives.IntList list)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.collections.primitives.IntList

equals, hashCode

Methods inherited from interface org.apache.commons.collections.primitives.IntCollection

contains, containsAll, isEmpty, size, toArray, toArray

Method Detail

wrap

public static final org.apache.commons.collections.primitives.IntList wrap(org.apache.commons.collections.primitives.IntList list)

add

public final void add(int index,
                      int element)

Description copied from interface: IntList

Inserts the specified element at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices.

Specified by:

add in interface IntList

Overrides:

add in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

Parameters:

index - the index at which to insert the element

element - the value to insert

addAll

public final boolean addAll(int index,
                            org.apache.commons.collections.primitives.IntCollection collection)

Description copied from interface: IntList

Inserts all of the elements in the specified collection into me, at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices. The new elements will appear in the order that they are returned by the given collection's iterator.

Specified by:

addAll in interface IntList

Overrides:

addAll in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

Parameters:

index - the index at which to insert the first element from the specified collection

collection - the IntCollection of elements to add

Returns:

true iff I changed as a result of this call

removeElementAt

public final int removeElementAt(int index)

Description copied from interface: IntList

Removes the element at the specified position in (optional operation). Any subsequent elements are shifted to the left, subtracting one from their indices. Returns the element that was removed.

Specified by:

removeElementAt in interface IntList

Overrides:

removeElementAt in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

Parameters:

index - the index of the element to remove

Returns:

the value of the element that was removed

set

public final int set(int index,
                     int element)

Description copied from interface: IntList

Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:

set in interface IntList

Overrides:

set in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

Parameters:

index - the index of the element to change

element - the value to be stored at the specified position

Returns:

the value previously stored at the specified position

add

public final boolean add(int element)

Description copied from interface: IntList

Appends the specified element to the end of me (optional operation). Returns true iff I changed as a result of this call.

If a collection refuses to add the specified element for any reason other than that it already contains the element, it must throw an exception (rather than simply returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface IntList

Overrides:

add in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

Parameters:

element - the value whose presence within me is to be ensured

Returns:

true iff I changed as a result of this call

addAll

public final boolean addAll(org.apache.commons.collections.primitives.IntCollection c)

Description copied from interface: IntCollection

Adds all of the elements in the specified collection to me (optional operation).

Specified by:

addAll in interface IntCollection

Overrides:

addAll in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

Parameters:

c - the collection of elements whose presence within me is to be ensured

Returns:

true iff I changed as a result of this call

clear

public final void clear()

Description copied from interface: IntCollection

Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:

clear in interface IntCollection

Overrides:

clear in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

removeAll

public final boolean removeAll(org.apache.commons.collections.primitives.IntCollection c)

Description copied from interface: IntCollection

Removes all of my elements that are contained in the specified collection (optional operation). The behavior of this method is unspecified if the given collection is modified while this method is executing. Note that this includes the case in which the given collection is this collection, and it is not empty.

Specified by:

removeAll in interface IntCollection

Overrides:

removeAll in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

Parameters:

c - the collection of elements to remove

Returns:

true iff I contained the at least one of the specified elements, in other words, returns true iff I changed as a result of this call

removeElement

public final boolean removeElement(int element)

Description copied from interface: IntCollection

Removes a single occurrence of the specified element (optional operation).

Specified by:

removeElement in interface IntCollection

Overrides:

removeElement in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

Parameters:

element - the element to remove, if present

Returns:

true iff I contained the specified element, in other words, iff I changed as a result of this call

retainAll

public final boolean retainAll(org.apache.commons.collections.primitives.IntCollection c)

Description copied from interface: IntCollection

Removes all of my elements that are not contained in the specified collection (optional operation). (In other words, retains only my elements that are contained in the specified collection.) The behavior of this method is unspecified if the given collection is modified while this method is executing.

Specified by:

retainAll in interface IntCollection

Overrides:

retainAll in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

Parameters:

c - the collection of elements to retain

Returns:

true iff I changed as a result of this call

subList

public final org.apache.commons.collections.primitives.IntList subList(int fromIndex,
                                                                       int toIndex)

Description copied from interface: IntList

Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned IntList is backed by me, so that any changes in the returned list are reflected in me, and vice-versa. The returned list supports all of the optional operations that I support.

Note that when fromIndex == toIndex, the returned list is initially empty, and when fromIndex == 0 && toIndex == size() the returned list is my "improper" sublist, containing all my elements.

The semantics of the returned list become undefined if I am structurally modified in any way other than via the returned list.

Specified by:

subList in interface IntList

Overrides:

subList in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

Parameters:

fromIndex - the smallest index (inclusive) in me that appears in the returned list

toIndex - the largest index (exclusive) in me that appears in the returned list

Returns:

a view of this list from fromIndex (inclusive) to toIndex (exclusive)

iterator

public final org.apache.commons.collections.primitives.IntIterator iterator()

Description copied from interface: IntList

Returns an iterator over all my elements, in the appropriate sequence.

Specified by:

iterator in interface IntList

Overrides:

iterator in class org.apache.commons.collections.primitives.decorators.BaseProxyIntCollection

Returns:

an iterator over all my elements.

listIterator

public org.apache.commons.collections.primitives.IntListIterator listIterator()

Description copied from interface: IntList

Returns a bidirectional iterator over all my elements, in the appropriate sequence.

Specified by:

listIterator in interface IntList

Overrides:

listIterator in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

listIterator

public org.apache.commons.collections.primitives.IntListIterator listIterator(int index)

Description copied from interface: IntList

Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Specified by:

listIterator in interface IntList

Overrides:

listIterator in class org.apache.commons.collections.primitives.decorators.BaseProxyIntList

get

public int get(int index)

Description copied from interface: IntList

Returns the value of the element at the specified position within me.

Specified by:

get in interface IntList

Parameters:

index - the index of the element to return

Returns:

the value of the element at the specified position

indexOf

public int indexOf(int element)

Description copied from interface: IntList

Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:

indexOf in interface IntList

Parameters:

element - the element to search for

Returns:

the smallest index of an element matching the specified value, or -1 if no such matching element can be found

lastIndexOf

public int lastIndexOf(int element)

Description copied from interface: IntList

Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:

lastIndexOf in interface IntList

Parameters:

element - the element to search for

Returns:

the largest index of an element matching the specified value, or -1 if no such matching element can be found

contains

public boolean contains(int element)

Description copied from interface: IntCollection

Returns true iff I contain the specified element.

Specified by:

contains in interface IntCollection

Parameters:

element - the value whose presence within me is to be tested

Returns:

true iff I contain the specified element

containsAll

public boolean containsAll(org.apache.commons.collections.primitives.IntCollection c)

Description copied from interface: IntCollection

Returns true iff I contain all of the elements in the given collection.

Specified by:

containsAll in interface IntCollection

Parameters:

c - the collection of elements whose presence within me is to be tested

Returns:

true iff I contain the all the specified elements

isEmpty

public boolean isEmpty()

Description copied from interface: IntCollection

Returns true iff I contain no elements.

Specified by:

isEmpty in interface IntCollection

Returns:

true iff I contain no elements.

size

public int size()

Description copied from interface: IntCollection

Returns the number of elements I contain.

Specified by:

size in interface IntCollection

Returns:

the number of elements I contain

toArray

public int[] toArray()

Description copied from interface: IntCollection

Returns an array containing all of my elements. The length of the returned array will be equal to my size.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:

toArray in interface IntCollection

Returns:

an array containing all my elements

toArray

public int[] toArray(int[] a)

Description copied from interface: IntCollection

Returns an array containing all of my elements, using the given array if it is large enough. When the length of the given array is larger than the number of elements I contain, values outside of my range will be unchanged.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:

toArray in interface IntCollection

Parameters:

a - an array that may be used to contain the elements

Returns:

an array containing all my elements

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object