Module org.apache.sis.util

Package org.apache.sis.util.collection

Class IntegerList

Object

AbstractCollection<Integer>

AbstractList<Integer>

IntegerList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Integer>, Collection<Integer>, List<Integer>, Random­Access, Sequenced­Collection<Integer>

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

Field Summary

Fields inherited from class AbstractList

mod­Count

Constructor Summary

Constructors

Constructor	Description
Integer­List(int initial­Capacity, int maximal­Value)	Creates an initially empty list with the given initial capacity.
Integer­List(int initial­Capacity, int maximal­Value, boolean fill)	Creates a new list with the given initial size.

Method Summary

Modifier and Type	Method	Description
boolean	add(Integer value)	Adds the given element to this list.
void	add­Int(int value)	Adds the given element as the int primitive type.
void	clear()	Discards all elements in this list.
Integer­List	clone()	Returns a clone of this list.
boolean	equals(Object other)	Compares the content of this list with the given object.
void	fill(int value)	Fills the list with the given value.
Integer	get(int index)	Returns the element at the given index.
int	get­Int(int index)	Returns the element at the given index as the int primitive type.
Primitive­Iterator.Of­Int	iterator()	Returns an iterator over the elements in this list in increasing index order.
int	maximal­Value()	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	remove­Last()	Retrieves and remove the last element of this list.
protected void	remove­Range(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	set­Int(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.
Spliterator.Of­Int	spliterator()	Returns an spliterator over the elements in this list in increasing index order.
Int­Stream	stream(boolean parallel)	Returns a stream of integers with this Integer­List as its source.
void	trim­To­Size()	Trims the capacity of this list to be its current size.

Methods inherited from class AbstractList

add, add­All, hash­Code, index­Of, last­Index­Of, list­Iterator, list­Iterator, sub­List

Methods inherited from class AbstractCollection

add­All, contains, contains­All, is­Empty, remove, remove­All, retain­All, to­Array, to­Array, to­String

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface Collection

parallel­Stream, remove­If, stream, to­Array

Methods inherited from interface Iterable

for­Each

Methods inherited from interface List

add­All, add­First, add­Last, contains, contains­All, get­First, get­Last, is­Empty, remove, remove­All, remove­First, replace­All, retain­All, reversed, sort, to­Array, to­Array

Constructor Details

IntegerList

public IntegerList(int initialCapacity,
 int maximalValue)

Creates an initially empty list with the given initial capacity.

Parameters:

initial­Capacity - the initial capacity.

maximal­Value - 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:

initial­Capacity - the initial capacity.

maximal­Value - 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 Details

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 Abstract­Collection<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:

• trim­To­Size()

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 Abstract­List<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 Abstract­List<Integer>

Parameters:

value - the value to add.

Returns:

always true.

Throws:

Null­Pointer­Exception - if the given value is null.

Illegal­Argument­Exception - 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:

Illegal­Argument­Exception - if the given value is out of bounds.

See Also:

• remove­Last()

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 Abstract­List<Integer>

Parameters:

index - the element index.

Returns:

the value at the given index.

Throws:

Index­Out­Of­Bounds­Exception - 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:

Index­Out­Of­Bounds­Exception - 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 Abstract­List<Integer>

Parameters:

index - the element index.

value - the value at the given index.

Returns:

the previous value at the given index.

Throws:

Index­Out­Of­Bounds­Exception - if the given index is out of bounds.

Illegal­Argument­Exception - if the given value is out of bounds.

Null­Pointer­Exception - 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:

Index­Out­Of­Bounds­Exception - if the given index is out of bounds.

Illegal­Argument­Exception - 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 Abstract­List<Integer>

Parameters:

index - the index of the element to remove.

Returns:

the previous value of the element at the given index.

Throws:

Index­Out­Of­Bounds­Exception - if the given index is out of bounds.

removeLast

public int removeLast()
               throws NoSuchElementException

Retrieves and remove the last element of this list.

Specified by:

remove­Last in interface List<Integer>

Specified by:

remove­Last in interface Sequenced­Collection<Integer>

Returns:

the tail of this list.

Throws:

No­Such­Element­Exception - 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:

remove­Range in class Abstract­List<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.

iterator

public PrimitiveIterator.OfInt iterator()

Returns an iterator over the elements in this list in increasing index order. The iterator is fail-fast and supports the remove operation.

Specified by:

iterator in interface Collection<Integer>

Specified by:

iterator in interface Iterable<Integer>

Specified by:

iterator in interface List<Integer>

Overrides:

iterator in class Abstract­List<Integer>

Returns:

iterator over the integer values in this list.

Since:

1.0

spliterator

public Spliterator.OfInt spliterator()

Returns an spliterator over the elements in this list in increasing index order. The iterator is fail-fast.

Specified by:

spliterator in interface Collection<Integer>

Specified by:

spliterator in interface Iterable<Integer>

Specified by:

spliterator in interface List<Integer>

Returns:

spliterator over the integer values in this list.

Since:

1.0

stream

public IntStream stream(boolean parallel)

Returns a stream of integers with this Integer­List as its source. This method is similar to Collection.stream(), but does not box the values. The returned stream is fail-fast, meaning that any modification to the list while using the stream will cause a Concurrent­Modification­Exception to be thrown.

The default implementation creates a parallel or sequential stream from spliterator().

Parameters:

parallel - true for a parallel stream, or false for a sequential stream.

Returns:

a stream of values in this list as primitive types.

Since:

1.0

trimToSize

public void trimToSize()

Trims the capacity of this list to be its current size.

See Also:

• size()
• resize(int)

equals

public boolean equals(Object other)

Compares the content of this list with the given object. This method overrides the default implementation for performance reasons.

Specified by:

equals in interface Collection<Integer>

Specified by:

equals in interface List<Integer>

Overrides:

equals in class Abstract­List<Integer>

Parameters:

other - the other object to compare with this list.

Returns:

true if both object are equal.

Since:

1.1

clone

public IntegerList clone()

Returns a clone of this list.

Overrides:

clone in class Object

Returns:

a clone of this list.