com.helger.collection.safe

Class SafeArrayList<ELEMENTTYPE>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ELEMENTTYPE>

com.helger.commons.collection.impl.CommonsArrayList<ELEMENTTYPE>

com.helger.collection.safe.SafeArrayList<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The type of the elements in the list

All Implemented Interfaces:

com.helger.commons.collection.impl.ICommonsCollection<ELEMENTTYPE>, com.helger.commons.collection.impl.ICommonsIterable<ELEMENTTYPE>, com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>, com.helger.commons.lang.ICloneable<com.helger.commons.collection.impl.ICommonsList<ELEMENTTYPE>>, com.helger.commons.lang.IHasSize, Serializable, Cloneable, Iterable<ELEMENTTYPE>, Collection<ELEMENTTYPE>, List<ELEMENTTYPE>, RandomAccess

@NotThreadSafe
public class SafeArrayList<ELEMENTTYPE>
extends com.helger.commons.collection.impl.CommonsArrayList<ELEMENTTYPE>

This is a specialized CommonsArrayList that can handle read accesses on list items that are not yet in the container. If get(int) is called with an index that would normally throw an ArrayIndexOutOfBoundsException this class will fill all indices between the current ArrayList.size() and the desired index with values provided by an ISupplier. If you don't pass an ISupplier in the constructor a default factory returning null values is used.

Author:

Philip

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SafeArrayList() Constructor filling up the missing elements with null values.
SafeArrayList(com.helger.commons.functional.ISupplier<? extends ELEMENTTYPE> aFactory) Constructor with a custom factory to fill the missing elements.

Method Summary

Modifier and Type	Method and Description
ELEMENTTYPE	computeIfAbsent(int nIndex, Supplier<? extends ELEMENTTYPE> aFactory)
boolean	equals(Object o)
ELEMENTTYPE	get(int nIndex)
com.helger.commons.functional.ISupplier<? extends ELEMENTTYPE>	getFactory()
int	hashCode()
ELEMENTTYPE	set(int nIndex, ELEMENTTYPE aElement)
String	toString()

Methods inherited from class com.helger.commons.collection.impl.CommonsArrayList

createFiltered, createFiltered, createFiltered, createFiltered, createFiltered, createFiltered, createInstance, getClone

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.collection.impl.ICommonsList

getAll, getAllInstanceOf, getAllMapped, getAllMapped, getAsUnmodifiable, getAtIndex, getFirst, getFirst, getLast, getLast, getSortedInline, removeAndReturnElementAtIndex, removeAtIndex, removeFirst, removeLast, reverse, setFirst, setLast, swapItems

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface com.helger.commons.collection.impl.ICommonsCollection

addAll, addAll, addAll, addAll, addAll, addAll, addAll, addAll, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addAllMapped, addIf, addIfNotNull, addObject, getAtIndex, getAtIndex, getAtIndex, getAtIndexMapped, getAtIndexMapped, getAtIndexMapped, getAtIndexMapped, getCopyAsList, getCount, getSorted, iterator2, removeAll, removeObject, set, setAll, setAll, setAllMapped, setAllMapped

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface com.helger.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstIndex, findFirstMapped, findFirstMapped, findLastIndex, forEach, forEachBreakable, forEachByIndex, getCount

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.helger.commons.lang.IHasSize

isEmpty, isNotEmpty, size

Constructor Detail

SafeArrayList

public SafeArrayList()

Constructor filling up the missing elements with null values.

SafeArrayList

public SafeArrayList(@Nonnull
                     com.helger.commons.functional.ISupplier<? extends ELEMENTTYPE> aFactory)

Constructor with a custom factory to fill the missing elements.

Parameters:

aFactory - The factory to use. May not be null.

Method Detail

getFactory

@Nonnull
public com.helger.commons.functional.ISupplier<? extends ELEMENTTYPE> getFactory()

Returns:

The factory for filling missing values as provided in the constructor.

get

public ELEMENTTYPE get(@Nonnegative
                       int nIndex)

Specified by:

get in interface List<ELEMENTTYPE>

Overrides:

get in class ArrayList<ELEMENTTYPE>

computeIfAbsent

@Nullable
public ELEMENTTYPE computeIfAbsent(@Nonnegative
                                              int nIndex,
                                              @Nonnull
                                              Supplier<? extends ELEMENTTYPE> aFactory)

set

public ELEMENTTYPE set(@Nonnegative
                       int nIndex,
                       @Nonnull
                       ELEMENTTYPE aElement)

Specified by:

set in interface List<ELEMENTTYPE>

Overrides:

set in class ArrayList<ELEMENTTYPE>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<ELEMENTTYPE>

Specified by:

equals in interface List<ELEMENTTYPE>

Overrides:

equals in class AbstractList<ELEMENTTYPE>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<ELEMENTTYPE>

Specified by:

hashCode in interface List<ELEMENTTYPE>

Overrides:

hashCode in class AbstractList<ELEMENTTYPE>

toString

public String toString()

Overrides:

toString in class AbstractCollection<ELEMENTTYPE>