org.sellcom.core.collection

Class SparseArray<E>

java.lang.Object

org.sellcom.core.collection.SparseArray<E>

All Implemented Interfaces:

Cloneable

public class SparseArray<E>
extends Object
implements Cloneable

Sparse array mapping integers to objects.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
SparseArray() Creates an empty sparse array.
SparseArray(int initialCapacity) Creates an empty sparse array with the given capacity.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all elements from this array.
SparseArray<E>	clone()
boolean	containsElement(E element) Checks whether this array contains the given element.
boolean	containsIndex(int index) Checks whether this array contains the given index.
void	ensureCapacity(int minCapacity) Increases the capacity of this array, if necessary, to ensure that it can hold at least the given number of elements.
void	forEach(BiConsumer<Integer,? super E> action) Performs the given action for each element in this array until all elements have been processed or the action throws an exception.
E	get(int index) Returns the element at the given index in this array.
E	getOrDefault(int index, E defaultValue) Returns the element at the given index in this array.
int	indexOf(E element) Returns the index of the first occurrence of the specified element in this array.
boolean	isEmpty() Checks whether this array is empty.
int	lastIndexOf(E element) Returns the index of the last occurrence of the specified element in this array.
E	remove(int index) Removes and returns the element at the given index in this array.
void	set(int index, E value) Sets the element at the given index in this array to the given value.
void	setIfAbsent(int index, E value) If there is no element in this array at the given index, sets it to the given value.
int	size() Returns the number of elements in this array.
String	toString()
void	trimToSize() Trims the capacity of this array to its current size.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SparseArray

public SparseArray()

Creates an empty sparse array.

Since:

1.0

SparseArray

public SparseArray(int initialCapacity)

Creates an empty sparse array with the given capacity.

Since:

1.0

Method Detail

clear

public void clear()

Removes all elements from this array.

Since:

1.0

clone

public SparseArray<E> clone()

Overrides:

clone in class Object

containsElement

public boolean containsElement(E element)

Checks whether this array contains the given element.

Throws:

IllegalArgumentException - if element is null

Since:

1.0

containsIndex

public boolean containsIndex(int index)

Checks whether this array contains the given index.

Throws:

IllegalArgumentException - if index is negative

Since:

1.0

ensureCapacity

public void ensureCapacity(int minCapacity)

Increases the capacity of this array, if necessary, to ensure that it can hold at least the given number of elements.

Throws:

IllegalArgumentException - if minCapacity is negative

Since:

1.0

forEach

public void forEach(BiConsumer<Integer,? super E> action)

Performs the given action for each element in this array until all elements have been processed or the action throws an exception. Actions are performed in the order of the element indices. Exceptions thrown by the action are relayed to the caller.

Throws:

IllegalArgumentException - if action is null

Since:

1.0

get

public E get(int index)

Returns the element at the given index in this array. Returns null if there is no element in this array at the given index.

Throws:

IllegalArgumentException - if index is negative

Since:

1.0

getOrDefault

public E getOrDefault(int index,
                      E defaultValue)

Returns the element at the given index in this array. Returns the given default value if there is no element in this array at the given index.

Throws:

IllegalArgumentException - if index is negative

Since:

1.0

indexOf

public int indexOf(E element)

Returns the index of the first occurrence of the specified element in this array. Returns -1 if this array does not contain the element.

Throws:

IllegalArgumentException - if element is null

Since:

1.0

isEmpty

public boolean isEmpty()

Checks whether this array is empty.

Since:

1.0

lastIndexOf

public int lastIndexOf(E element)

Returns the index of the last occurrence of the specified element in this array. Returns -1 if this array does not contain the element.

Throws:

IllegalArgumentException - if element is null

Since:

1.0

remove

public E remove(int index)

Removes and returns the element at the given index in this array. Returns null if there is no element in this array at the given index.

Throws:

IllegalArgumentException - if index is negative

Since:

1.0

set

public void set(int index,
                E value)

Sets the element at the given index in this array to the given value.

Throws:

IllegalArgumentException - if index is negative

IllegalArgumentException - if value is null

Since:

1.0

setIfAbsent

public void setIfAbsent(int index,
                        E value)

If there is no element in this array at the given index, sets it to the given value.

Throws:

IllegalArgumentException - if index is negative

IllegalArgumentException - if value is null

Since:

1.0

size

public int size()

Returns the number of elements in this array.

Since:

1.0

toString

public String toString()

Overrides:

toString in class Object

trimToSize

public void trimToSize()

Trims the capacity of this array to its current size.

Since:

1.0