org.apache.commons.collections.primitives
Class ArrayShortList

java.lang.Object
  extended by org.apache.commons.collections.primitives.AbstractShortCollection
      extended by org.apache.commons.collections.primitives.RandomAccessShortList
          extended by org.apache.commons.collections.primitives.ArrayShortList
All Implemented Interfaces:
java.io.Serializable, ShortCollection, ShortList

public class ArrayShortList
extends RandomAccessShortList
implements ShortList, java.io.Serializable

An ShortList backed by an array of shorts. 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.RandomAccessShortList
RandomAccessShortList.RandomAccessShortListIterator, RandomAccessShortList.RandomAccessShortSubList
 
Constructor Summary
ArrayShortList()
          Construct an empty list with the default initial capacity.
ArrayShortList(int initialCapacity)
          Construct an empty list with the given initial capacity.
ArrayShortList(short[] array)
          Constructs a list by copying the specified array.
ArrayShortList(ShortCollection 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, short element)
          Inserts the specified element at the specified position (optional operation).
 boolean addAll(int index, ShortCollection collection)
          Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
 boolean addAll(ShortCollection 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.
 short get(int index)
          Returns the value of the element at the specified position within me.
 short removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 short set(int index, short 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.RandomAccessShortList
add, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractShortCollection
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.ShortList
add, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from interface org.apache.commons.collections.primitives.ShortCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Constructor Detail

ArrayShortList

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


ArrayShortList

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

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

ArrayShortList

public ArrayShortList(ShortCollection 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 shorts to add
Throws:
java.lang.NullPointerException - if that is null
See Also:
addAll(org.apache.commons.collections.primitives.ShortCollection)

ArrayShortList

public ArrayShortList(short[] 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 short get(int index)
Description copied from interface: ShortList
Returns the value of the element at the specified position within me.

Specified by:
get in interface ShortList
Specified by:
get in class RandomAccessShortList
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: ShortCollection
Returns the number of elements I contain.

Specified by:
size in interface ShortCollection
Specified by:
size in class RandomAccessShortList
Returns:
the number of elements I contain

removeElementAt

public short 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 ShortList
Overrides:
removeElementAt in class RandomAccessShortList
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 short set(int index,
                 short element)
Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:
set in interface ShortList
Overrides:
set in class RandomAccessShortList
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,
                short 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 ShortList
Overrides:
add in class RandomAccessShortList
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: ShortCollection
Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:
clear in interface ShortCollection
Overrides:
clear in class AbstractShortCollection

addAll

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

Specified by:
addAll in interface ShortCollection
Overrides:
addAll in class AbstractShortCollection
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,
                      ShortCollection collection)
Description copied from interface: ShortList
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 ShortList
Overrides:
addAll in class RandomAccessShortList
Parameters:
index - the index at which to insert the first element from the specified collection
collection - the ShortCollection 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-2009 Apache Software Foundation. All Rights Reserved.