org.apache.commons.collections.primitives
Class ArrayUnsignedIntList

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.ArrayUnsignedIntList
All Implemented Interfaces:
Serializable, LongCollection, LongList

public class ArrayUnsignedIntList
extends RandomAccessLongList
implements LongList, Serializable

An IntList backed by an array of unsigned int values. This list stores int values in the range [0, 65535] in 16-bits per element. Attempts to use elements outside this range may cause an IllegalArgumentException to be thrown.

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
 
Field Summary
static long MAX_VALUE
          The maximum possible unsigned 32-bit value.
static long MIN_VALUE
          The minimum possible unsigned 32-bit value.
 
Constructor Summary
ArrayUnsignedIntList()
          Construct an empty list with the default initial capacity.
ArrayUnsignedIntList(int initialCapacity)
          Construct an empty list with the given initial capacity.
ArrayUnsignedIntList(long[] array)
          Constructs a list by copying the specified array.
ArrayUnsignedIntList(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).
 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 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, addAll, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractLongCollection
addAll, 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, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from interface org.apache.commons.collections.primitives.LongCollection
addAll, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Field Detail

MAX_VALUE

public static final long MAX_VALUE
The maximum possible unsigned 32-bit value.

See Also:
Constant Field Values

MIN_VALUE

public static final long MIN_VALUE
The minimum possible unsigned 32-bit value.

See Also:
Constant Field Values
Constructor Detail

ArrayUnsignedIntList

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


ArrayUnsignedIntList

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

Throws:
IllegalArgumentException - when initialCapacity is negative

ArrayUnsignedIntList

public ArrayUnsignedIntList(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 ints to add
Throws:
NullPointerException - if that is null
See Also:
AbstractLongCollection.addAll(LongCollection)

ArrayUnsignedIntList

public ArrayUnsignedIntList(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)
Returns the element at the specified position within me. By construction, the returned value will be between MIN_VALUE and MAX_VALUE, inclusive.

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
Throws:
IndexOutOfBoundsException - if the specified index is out of range

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. By construction, the returned value will be between MIN_VALUE and MAX_VALUE, inclusive.

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). Throws IllegalArgumentException if element is less than MIN_VALUE or greater than MAX_VALUE.

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. Throws IllegalArgumentException if element is less than MIN_VALUE or greater than MAX_VALUE.

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

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-2010 Apache Software Foundation. All Rights Reserved.