IntegerList (Apache SIS 0.8 API)

Object
- AbstractCollection<E>
- - AbstractList<Integer>
  - - IntegerList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Integer>, Collection<Integer>, List<Integer>, RandomAccess
```
public class IntegerList
extends AbstractList<Integer>
implements RandomAccess, Serializable, Cloneable
```
A list of unsigned integer values. This class packs the values in the minimal amount of bits required for storing unsigned integers of the given maximal value.
This class is not thread-safe. Synchronizations (if wanted) are user's responsibility.

Since:

0.7

See Also:

Vector, Serialized Form

Defined in the sis-utility module

Field Summary
- Fields inherited from class AbstractList
  modCount

Constructor Summary

Constructors
Constructor and Description
`IntegerList(int initialCapacity, int maximalValue)` Creates an initially empty list with the given initial capacity.
`IntegerList(int initialCapacity, int maximalValue, boolean fill)` Creates a new list with the given initial size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Integer value)` Adds the given element to this list.
`void`	`addInt(int value)` Adds the given element as the `int` primitive type.
`void`	`clear()` Discards all elements in this list.
`IntegerList`	`clone()` Returns a clone of this list.
`void`	`fill(int value)` Fills the list with the given value.
`Integer`	`get(int index)` Returns the element at the given index.
`int`	`getInt(int index)` Returns the element at the given index as the `int` primitive type.
`int`	`maximalValue()` Returns the maximal value that can be stored in this list.
`int`	`occurrence(int value)` Returns the occurrence of the given value in this list.
`Integer`	`remove(int index)` Removes the element at the given index.
`int`	`removeLast()` Retrieves and remove the last element of this list.
`protected void`	`removeRange(int lower, int upper)` Removes all values in the given range of index.
`void`	`resize(int size)` Sets the list size to the given value.
`Integer`	`set(int index, Integer value)` Sets the element at the given index.
`void`	`setInt(int index, int value)` Sets the element at the given index as the `int` primitive type.
`int`	`size()` Returns the current number of values in this list.
`void`	`trimToSize()` Trims the capacity of this list to be its current size.

Methods inherited from class AbstractList
add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

Methods inherited from class AbstractCollection
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface List
addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface Collection
parallelStream, removeIf, stream

Methods inherited from interface Iterable
forEach

- Constructor Detail
  - IntegerList
```
public IntegerList(int initialCapacity,
                   int maximalValue)
```
    Creates an initially empty list with the given initial capacity.
    
    Parameters:
    
    initialCapacity - the initial capacity.
    
    maximalValue - the maximal value to be allowed, inclusive.
  - IntegerList
```
public IntegerList(int initialCapacity,
                   int maximalValue,
                   boolean fill)
```
    Creates a new list with the given initial size. The value of all elements are initialized to 0.
    
    Parameters:
    
    initialCapacity - the initial capacity.
    
    maximalValue - the maximal value to be allowed, inclusive.
    
    fill - if true, the initial size is set to the initial capacity with all values set to 0.
- Method Detail
  - maximalValue
```
public int maximalValue()
```
    Returns the maximal value that can be stored in this list. May be slightly higher than the value given to the constructor.
    
    Returns:
    
    the maximal value, inclusive.
  - size
```
public int size()
```
    Returns the current number of values in this list.
    
    Specified by:
    
    size in interface Collection<Integer>
    
    Specified by:
    
    size in interface List<Integer>
    
    Specified by:
    
    size in class AbstractCollection<Integer>
    
    Returns:
    
    the number of values.
  - resize
```
public void resize(int size)
```
    Sets the list size to the given value. If the new size is lower than previous size, then the elements after the new size are discarded. If the new size is greater than the previous one, then the extra elements are initialized to 0.
    
    Parameters:
    
    size - the new size.
    
    See Also:
    
    trimToSize()
  - fill
```
public void fill(int value)
```
    Fills the list with the given value. Every existing values are overwritten from index 0 inclusive up to size() exclusive.
    
    Parameters:
    
    value - the value to set.
  - clear
```
public void clear()
```
    Discards all elements in this list.
    
    Specified by:
    
    clear in interface Collection<Integer>
    
    Specified by:
    
    clear in interface List<Integer>
    
    Overrides:
    
    clear in class AbstractList<Integer>
  - add
```
public boolean add(Integer value)
            throws IllegalArgumentException
```
    Adds the given element to this list.
    
    Specified by:
    
    add in interface Collection<Integer>
    
    Specified by:
    
    add in interface List<Integer>
    
    Overrides:
    
    add in class AbstractList<Integer>
    
    Parameters:
    
    value - the value to add.
    
    Returns:
    
    always true.
    
    Throws:
    
    NullPointerException - if the given value is null.
    
    IllegalArgumentException - if the given value is out of bounds.
  - addInt
```
public void addInt(int value)
            throws IllegalArgumentException
```
    Adds the given element as the int primitive type.
    
    Parameters:
    
    value - the value to add.
    
    Throws:
    
    IllegalArgumentException - if the given value is out of bounds.
    
    See Also:
    
    removeLast()
  - get
```
public Integer get(int index)
            throws IndexOutOfBoundsException
```
    Returns the element at the given index.
    
    Specified by:
    
    get in interface List<Integer>
    
    Specified by:
    
    get in class AbstractList<Integer>
    
    Parameters:
    
    index - the element index.
    
    Returns:
    
    the value at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
  - getInt
```
public int getInt(int index)
           throws IndexOutOfBoundsException
```
    Returns the element at the given index as the int primitive type.
    
    Parameters:
    
    index - the element index.
    
    Returns:
    
    the value at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
  - set
```
public Integer set(int index,
                   Integer value)
            throws IndexOutOfBoundsException
```
    Sets the element at the given index.
    
    Specified by:
    
    set in interface List<Integer>
    
    Overrides:
    
    set in class AbstractList<Integer>
    
    Parameters:
    
    index - the element index.
    
    value - the value at the given index.
    
    Returns:
    
    the previous value at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
    
    IllegalArgumentException - if the given value is out of bounds.
    
    NullPointerException - if the given value is null.
  - setInt
```
public void setInt(int index,
                   int value)
            throws IndexOutOfBoundsException
```
    Sets the element at the given index as the int primitive type.
    
    Parameters:
    
    index - the element index.
    
    value - the value at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
    
    IllegalArgumentException - if the given value is out of bounds.
  - remove
```
public Integer remove(int index)
               throws IndexOutOfBoundsException
```
    Removes the element at the given index.
    
    Specified by:
    
    remove in interface List<Integer>
    
    Overrides:
    
    remove in class AbstractList<Integer>
    
    Parameters:
    
    index - the index of the element to remove.
    
    Returns:
    
    the previous value of the element at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.
  - removeLast
```
public int removeLast()
               throws NoSuchElementException
```
    Retrieves and remove the last element of this list.
    
    Returns:
    
    the tail of this list.
    
    Throws:
    
    NoSuchElementException - if this list is empty.
  - removeRange
```
protected void removeRange(int lower,
                           int upper)
```
    Removes all values in the given range of index. Shifts any succeeding elements to the left (reduces their index).
    
    Overrides:
    
    removeRange in class AbstractList<Integer>
    
    Parameters:
    
    lower - index of the first element to remove, inclusive.
    
    upper - index after the last element to be removed.
  - occurrence
```
public int occurrence(int value)
```
    Returns the occurrence of the given value in this list.
    
    Parameters:
    
    value - the value to search for.
    
    Returns:
    
    the number of time the given value occurs in this list.
  - trimToSize
```
public void trimToSize()
```
    Trims the capacity of this list to be its current size.
    
    See Also:
    
    size(), resize(int)
  - clone
```
public IntegerList clone()
```
    Returns a clone of this list.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this list.

Class IntegerList

Field Summary

Fields inherited from class AbstractList

Constructor Summary

Method Summary

Methods inherited from class AbstractList

Methods inherited from class AbstractCollection

Methods inherited from class Object

Methods inherited from interface List

Methods inherited from interface Collection

Methods inherited from interface Iterable

Constructor Detail

IntegerList

IntegerList

Method Detail

maximalValue

size

resize

fill

clear

add

addInt

get

getInt

set

setInt

remove

removeLast

removeRange

occurrence

trimToSize

clone