org.apache.commons.collections.primitives.adapters
Class AbstractListLongList

java.lang.Object
  extended byorg.apache.commons.collections.primitives.adapters.AbstractCollectionLongCollection
      extended byorg.apache.commons.collections.primitives.adapters.AbstractListLongList
All Implemented Interfaces:
LongCollection, LongList
Direct Known Subclasses:
ListLongList, NonSerializableListLongList

abstract class AbstractListLongList
extends AbstractCollectionLongCollection
implements LongList

Since:
Commons Primitives 1.0
Version:
$Revision: 1.3 $ $Date: 2003/10/16 20:49:38 $
Author:
Rodney Waldhoff

Constructor Summary
(package private) AbstractListLongList()
           
 
Method Summary
 void add(int index, long element)
          Inserts the specified element at the specified position (optional operation).
 boolean add(long element)
          Appends the specified element to the end of me (optional operation).
 boolean addAll(int index, LongCollection collection)
          Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
 boolean addAll(LongCollection c)
          Adds all of the elements in the specified collection to me (optional operation).
 void clear()
          Removes all my elements (optional operation).
 boolean contains(long element)
          Returns true iff I contain the specified element.
 boolean containsAll(LongCollection c)
          Returns true iff I contain all of the elements in the given collection.
 boolean equals(java.lang.Object obj)
          Returns true iff that is an LongList that contains the same elements in the same order as me.
 long get(int index)
          Returns the value of the element at the specified position within me.
protected  java.util.Collection getCollection()
           
protected abstract  java.util.List getList()
           
 int hashCode()
          Returns my hash code.
 int indexOf(long 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.
 LongIterator iterator()
          wraps the Iterator returned by my underlying Collection, if any.
 int lastIndexOf(long element)
          Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.
 LongListIterator listIterator()
          wraps the LongList returned by my underlying LongListIterator, if any.
 LongListIterator listIterator(int index)
          wraps the LongList returned by my underlying LongListIterator, if any.
 boolean removeAll(LongCollection c)
          Removes all of my elements that are contained in the specified collection (optional operation).
 boolean removeElement(long element)
          Removes a single occurrence of the specified element (optional operation).
 long removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 boolean retainAll(LongCollection c)
          Removes all of my elements that are not contained in the specified collection (optional operation).
 long set(int index, long 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.
 LongList subList(int fromIndex, int toIndex)
          Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
 long[] toArray()
          Returns an array containing all of my elements.
 long[] toArray(long[] dest)
          Returns an array containing all of my elements, using the given array if it is large enough.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.primitives.LongList
add, iterator
 
Methods inherited from interface org.apache.commons.collections.primitives.LongCollection
addAll, clear, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, size, toArray, toArray
 

Constructor Detail

AbstractListLongList

AbstractListLongList()
Method Detail

add

public void add(int index,
                long element)
Description copied from interface: LongList
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 LongList
Parameters:
index - the index at which to insert the element
element - the value to insert

addAll

public boolean addAll(int index,
                      LongCollection collection)
Description copied from interface: LongList
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 LongList
Parameters:
index - the index at which to insert the first element from the specified collection
collection - the LongCollection of elements to add
Returns:
true iff I changed as a result of this call

get

public long get(int index)
Description copied from interface: LongList
Returns the value of the element at the specified position within me.

Specified by:
get in interface LongList
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position

indexOf

public int indexOf(long element)
Description copied from interface: LongList
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 LongList
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(long element)
Description copied from interface: LongList
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 LongList
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

listIterator

public LongListIterator listIterator()
wraps the LongList returned by my underlying LongListIterator, if any.

Specified by:
listIterator in interface LongList

listIterator

public LongListIterator listIterator(int index)
wraps the LongList returned by my underlying LongListIterator, if any.

Specified by:
listIterator in interface LongList

removeElementAt

public long removeElementAt(int index)
Description copied from interface: LongList
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 LongList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed

set

public long set(int index,
                long element)
Description copied from interface: LongList
Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:
set in interface LongList
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

subList

public LongList subList(int fromIndex,
                        int toIndex)
Description copied from interface: LongList
Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned LongList 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 LongList
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)

equals

public boolean equals(java.lang.Object obj)
Description copied from interface: LongList
Returns true iff that is an LongList that contains the same elements in the same order as me. In other words, returns true iff that is an LongList that has the same size as me, and for which the elements returned by its iterator are equal (==) to the corresponding elements within me. (This contract ensures that this method works properly across different implementations of the LongList interface.)

Specified by:
equals in interface LongList

hashCode

public int hashCode()
Description copied from interface: LongList
Returns my hash code.

The hash code of an LongList is defined to be the result of the following calculation:

 int hash = 1;
 for(LongIterator iter = iterator(); iter.hasNext(); ) {
   long value = iter.next();
   hash = 31*hash + (int)(value ^ (value >>> 32));
 }

This contract ensures that this method is consistent with equals and with the hashCode method of a List of Longs.

Specified by:
hashCode in interface LongList

getCollection

protected final java.util.Collection getCollection()
Specified by:
getCollection in class AbstractCollectionLongCollection

getList

protected abstract java.util.List getList()

add

public boolean add(long element)
Description copied from interface: LongCollection
Ensures that I contain the specified element (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 LongCollection
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 boolean addAll(LongCollection c)
Description copied from interface: LongCollection
Adds all of the elements in the specified collection to me (optional operation).

Specified by:
addAll in interface LongCollection
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 void clear()
Description copied from interface: LongCollection
Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:
clear in interface LongCollection

contains

public boolean contains(long element)
Description copied from interface: LongCollection
Returns true iff I contain the specified element.

Specified by:
contains in interface LongCollection
Parameters:
element - the value whose presence within me is to be tested
Returns:
true iff I contain the specified element

containsAll

public boolean containsAll(LongCollection c)
Description copied from interface: LongCollection
Returns true iff I contain all of the elements in the given collection.

Specified by:
containsAll in interface LongCollection
Parameters:
c - the collection of elements whose presence within me is to be tested
Returns:
true iff I contain the all the specified elements

toString

public java.lang.String toString()

isEmpty

public boolean isEmpty()
Description copied from interface: LongCollection
Returns true iff I contain no elements.

Specified by:
isEmpty in interface LongCollection
Returns:
true iff I contain no elements.

iterator

public LongIterator iterator()
wraps the Iterator returned by my underlying Collection, if any.

Specified by:
iterator in interface LongCollection
Returns:
an iterator over all my elements.

removeElement

public boolean removeElement(long element)
Description copied from interface: LongCollection
Removes a single occurrence of the specified element (optional operation).

Specified by:
removeElement in interface LongCollection
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

removeAll

public boolean removeAll(LongCollection c)
Description copied from interface: LongCollection
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 LongCollection
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

retainAll

public boolean retainAll(LongCollection c)
Description copied from interface: LongCollection
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 LongCollection
Parameters:
c - the collection of elements to retain
Returns:
true iff I changed as a result of this call

size

public int size()
Description copied from interface: LongCollection
Returns the number of elements I contain.

Specified by:
size in interface LongCollection
Returns:
the number of elements I contain

toArray

public long[] toArray()
Description copied from interface: LongCollection
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 LongCollection
Returns:
an array containing all my elements

toArray

public long[] toArray(long[] dest)
Description copied from interface: LongCollection
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 LongCollection
Parameters:
dest - an array that may be used to contain the elements
Returns:
an array containing all my elements


Copyright (c) 2002-2003 - Apache Software Foundation