org.apache.commons.collections.primitives
Class ArrayLongList

java.lang.Object
  extended by org.apache.commons.collections.primitives.AbstractLongCollection
      extended by org.apache.commons.collections.primitives.RandomAccessLongList
          extended by org.apache.commons.collections.primitives.ArrayLongList
All Implemented Interfaces:
Serializable, LongCollection, LongList

public class ArrayLongList
extends RandomAccessLongList
implements LongList, Serializable

An LongList backed by an array of longs. This implementation supports all optional methods.

Since:
Commons Primitives 1.0
Version:
$Revision: 480460 $ $Date: 2006-11-29 09:14:21 +0100 (Wed, 29 Nov 2006) $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessLongList
RandomAccessLongList.RandomAccessLongListIterator, RandomAccessLongList.RandomAccessLongSubList
 
Constructor Summary
ArrayLongList()
          Construct an empty list with the default initial capacity.
ArrayLongList(int initialCapacity)
          Construct an empty list with the given initial capacity.
ArrayLongList(long[] array)
          Constructs a list by copying the specified array.
ArrayLongList(LongCollection that)
          Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.
 
Method Summary
 void add(int index, long element)
          Inserts the specified element at the specified position (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 collection)
          Adds all of the elements in the specified collection to me (optional operation).
 void clear()
          Removes all my elements (optional operation).
 void ensureCapacity(int mincap)
          Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.
 long get(int index)
          Returns the value of the element at the specified position within me.
 long removeElementAt(int index)
          Removes the element at the specified position in (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.
 void trimToSize()
          Reduce my capacity, if necessary, to match my current size.
 
Methods inherited from class org.apache.commons.collections.primitives.RandomAccessLongList
add, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractLongCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 
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, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from interface org.apache.commons.collections.primitives.LongCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Constructor Detail

ArrayLongList

public ArrayLongList()
Construct an empty list with the default initial capacity.


ArrayLongList

public ArrayLongList(int initialCapacity)
Construct an empty list with the given initial capacity.

Throws:
IllegalArgumentException - when initialCapacity is negative

ArrayLongList

public ArrayLongList(LongCollection that)
Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.

Parameters:
that - the non-null collection of longs to add
Throws:
NullPointerException - if that is null
See Also:
addAll(org.apache.commons.collections.primitives.LongCollection)

ArrayLongList

public ArrayLongList(long[] array)
Constructs a list by copying the specified array.

Parameters:
array - the array to initialize the collection with
Throws:
NullPointerException - if the array is null
Method Detail

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
Specified by:
get in class RandomAccessLongList
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position

size

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

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

removeElementAt

public long removeElementAt(int index)
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
Overrides:
removeElementAt in class RandomAccessLongList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed
Throws:
UnsupportedOperationException - when this operation is not supported
IndexOutOfBoundsException - if the specified index is out of range

set

public long set(int index,
                long element)
Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:
set in interface LongList
Overrides:
set in class RandomAccessLongList
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
Throws:
UnsupportedOperationException - when this operation is not supported
IndexOutOfBoundsException - if the specified index is out of range

add

public void add(int index,
                long element)
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
Overrides:
add in class RandomAccessLongList
Parameters:
index - the index at which to insert the element
element - the value to insert
Throws:
UnsupportedOperationException - when this operation is not supported
IllegalArgumentException - if some aspect of the specified element prevents it from being added to me
IndexOutOfBoundsException - if the specified index is out of range

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
Overrides:
clear in class AbstractLongCollection

addAll

public boolean addAll(LongCollection collection)
Description copied from interface: LongCollection
Adds all of the elements in the specified collection to me (optional operation).

Specified by:
addAll in interface LongCollection
Overrides:
addAll in class AbstractLongCollection
Parameters:
collection - the collection of elements whose presence within me is to be ensured
Returns:
true iff I changed as a result of this call

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
Overrides:
addAll in class RandomAccessLongList
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

ensureCapacity

public void ensureCapacity(int mincap)
Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.


trimToSize

public void trimToSize()
Reduce my capacity, if necessary, to match my current size.



Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.