org.apache.commons.collections.primitives
Class ArrayUnsignedShortList

java.lang.Object
  extended by org.apache.commons.collections.primitives.AbstractIntCollection
      extended by org.apache.commons.collections.primitives.RandomAccessIntList
          extended by org.apache.commons.collections.primitives.ArrayUnsignedShortList
All Implemented Interfaces:
java.io.Serializable, IntCollection, IntList

public class ArrayUnsignedShortList
extends RandomAccessIntList
implements IntList, java.io.Serializable

An IntList backed by an array of unsigned short 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.RandomAccessIntList
RandomAccessIntList.RandomAccessIntListIterator, RandomAccessIntList.RandomAccessIntSubList
 
Field Summary
static int MAX_VALUE
          The maximum possible unsigned 16-bit value (0xFFFF).
static int MIN_VALUE
          The minimum possible unsigned 16-bit value (0x0000).
 
Constructor Summary
ArrayUnsignedShortList()
          Construct an empty list with the default initial capacity.
ArrayUnsignedShortList(int initialCapacity)
          Construct an empty list with the given initial capacity.
ArrayUnsignedShortList(int[] array)
          Constructs a list by copying the specified array.
ArrayUnsignedShortList(IntCollection 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, int 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.
 int get(int index)
          Returns the element at the specified position within me.
 int removeElementAt(int index)
          Removes the element at the specified position in (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.
 void trimToSize()
          Reduce my capacity, if necessary, to match my current size.
 
Methods inherited from class org.apache.commons.collections.primitives.RandomAccessIntList
add, addAll, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractIntCollection
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.IntList
add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from interface org.apache.commons.collections.primitives.IntCollection
addAll, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Field Detail

MAX_VALUE

public static final int MAX_VALUE
The maximum possible unsigned 16-bit value (0xFFFF).

See Also:
Constant Field Values

MIN_VALUE

public static final int MIN_VALUE
The minimum possible unsigned 16-bit value (0x0000).

See Also:
Constant Field Values
Constructor Detail

ArrayUnsignedShortList

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


ArrayUnsignedShortList

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

Throws:
java.lang.IllegalArgumentException - when initialCapacity is negative

ArrayUnsignedShortList

public ArrayUnsignedShortList(IntCollection 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:
java.lang.NullPointerException - if that is null
See Also:
ArrayIntList.addAll(org.apache.commons.collections.primitives.IntCollection)

ArrayUnsignedShortList

public ArrayUnsignedShortList(int[] array)
Constructs a list by copying the specified array.

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

get

public int 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 IntList
Specified by:
get in class RandomAccessIntList
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position
Throws:
java.lang.IndexOutOfBoundsException - if the specified index is out of range

size

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

Specified by:
size in interface IntCollection
Specified by:
size in class RandomAccessIntList
Returns:
the number of elements I contain

removeElementAt

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

set

public int set(int index,
               int 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 IntList
Overrides:
set in class RandomAccessIntList
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:
java.lang.UnsupportedOperationException - when this operation is not supported
java.lang.IndexOutOfBoundsException - if the specified index is out of range

add

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

clear

public 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 AbstractIntCollection

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