ArrayUnsignedByteList (Commons Primitives 1.1-SNAPSHOT API)

java.lang.Object
- org.apache.commons.collections.primitives.AbstractShortCollection
- - org.apache.commons.collections.primitives.RandomAccessShortList
  - - org.apache.commons.collections.primitives.ArrayUnsignedByteList

All Implemented Interfaces:

Serializable, ShortCollection, ShortList
```
public class ArrayUnsignedByteList
extends RandomAccessShortList
implements ShortList, Serializable
```
A ShortList backed by an array of unsigned byte values. This list stores short values in the range [MIN_VALUE, MAX_VALUE] in 8-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 03:14:21 -0500 (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

Field Summary

Fields
Modifier and Type Field and Description

static short MAX_VALUE
The maximum possible unsigned 8-bit value.

static short MIN_VALUE
The minimum possible unsigned 8-bit value.

Fields
Modifier and Type	Field and Description
`static short`	`MAX_VALUE` The maximum possible unsigned 8-bit value.
`static short`	`MIN_VALUE` The minimum possible unsigned 8-bit value.

Constructor Summary

Constructors
Constructor and Description
`ArrayUnsignedByteList()` Construct an empty list with the default initial capacity.
`ArrayUnsignedByteList(int initialCapacity)` Construct an empty list with the given initial capacity.
`ArrayUnsignedByteList(short[] array)` Constructs a list by copying the specified array.
`ArrayUnsignedByteList(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

Methods
Modifier and Type	Method and Description
`void`	`add(int index, short 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.
`short`	`get(int index)` Returns 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, addAll, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString

Methods inherited from class org.apache.commons.collections.primitives.AbstractShortCollection
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.ShortList
add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

Methods inherited from interface org.apache.commons.collections.primitives.ShortCollection
addAll, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray

- Field Detail
  - MAX_VALUE
```
public static final short MAX_VALUE
```
    The maximum possible unsigned 8-bit value.
    
    See Also:
    Constant Field Values
  - MIN_VALUE
```
public static final short MIN_VALUE
```
    The minimum possible unsigned 8-bit value.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ArrayUnsignedByteList
```
public ArrayUnsignedByteList()
```
    Construct an empty list with the default initial capacity.
  - ArrayUnsignedByteList
```
public ArrayUnsignedByteList(int initialCapacity)
```
    Construct an empty list with the given initial capacity.
    
    Throws:
    
    IllegalArgumentException - when initialCapacity is negative
  - ArrayUnsignedByteList
```
public ArrayUnsignedByteList(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 ints to add
    
    Throws:
    
    NullPointerException - if that is null
    See Also:
    ShortCollection.addAll(org.apache.commons.collections.primitives.ShortCollection)
  - ArrayUnsignedByteList
```
public ArrayUnsignedByteList(short[] 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 short 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 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
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is out of range
  - 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. By construction, the returned value will be between MIN_VALUE and MAX_VALUE, inclusive.
    
    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:
    
    UnsupportedOperationException - when this operation is not supported
    
    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). Throws IllegalArgumentException if element is less than MIN_VALUE or greater than MAX_VALUE.
    
    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:
    
    UnsupportedOperationException - when this operation is not supported
    
    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. Throws IllegalArgumentException if element is less than MIN_VALUE or greater than MAX_VALUE.
    
    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:
    
    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: 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
  - 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.

Class ArrayUnsignedByteList

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessShortList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.collections.primitives.RandomAccessShortList

Methods inherited from class org.apache.commons.collections.primitives.AbstractShortCollection

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.collections.primitives.ShortList

Methods inherited from interface org.apache.commons.collections.primitives.ShortCollection

Field Detail

MAX_VALUE

MIN_VALUE

Constructor Detail

ArrayUnsignedByteList

ArrayUnsignedByteList

ArrayUnsignedByteList

ArrayUnsignedByteList

Method Detail

get

size

removeElementAt

set

add

clear

ensureCapacity

trimToSize