com.helger.commons.collection.ext

Interface ICommonsList<ELEMENTTYPE>

All Superinterfaces:

Collection<ELEMENTTYPE>, ICloneable<ICommonsList<ELEMENTTYPE>>, ICommonsCollection<ELEMENTTYPE>, Iterable<ELEMENTTYPE>, List<ELEMENTTYPE>, Serializable

All Known Implementing Classes:

CommonsArrayList, CommonsCopyOnWriteArrayList, CommonsLinkedList, CommonsVector, KeyValuePairList, NonBlockingStack, SafeArrayList, SafeVector, SingleElementList, WrappedList

public interface ICommonsList<ELEMENTTYPE>
extends List<ELEMENTTYPE>, ICommonsCollection<ELEMENTTYPE>, ICloneable<ICommonsList<ELEMENTTYPE>>

Method Summary

Modifier and Type	Method and Description
default <T> ICommonsList<T>	createInstance() Create a new empty list.
default ICommonsList<ELEMENTTYPE>	getAll(Predicate<? super ELEMENTTYPE> aFilter)
default <DSTTYPE extends ELEMENTTYPE> ICommonsList<DSTTYPE>	getAllInstanceOf(Class<DSTTYPE> aDstClass)
default <DSTTYPE> ICommonsList<DSTTYPE>	getAllMapped(Function<? super ELEMENTTYPE,DSTTYPE> aMapper)
default <DSTTYPE> ICommonsList<DSTTYPE>	getAllMapped(Predicate<? super ELEMENTTYPE> aFilter, Function<? super ELEMENTTYPE,DSTTYPE> aMapper)
default List<ELEMENTTYPE>	getAsUnmodifiable()
default ELEMENTTYPE	getAtIndex(int nIndex, ELEMENTTYPE aDefault) Safe list element accessor method.
default ELEMENTTYPE	getFirst()
default ELEMENTTYPE	getLast()
default ELEMENTTYPE	removeAndReturnElementAtIndex(int nIndex) Remove the element at the specified index from the passed list.
default EChange	removeAtIndex(int nIndex) Remove the element at the specified index from the passed list.
default ELEMENTTYPE	removeFirst()
default ELEMENTTYPE	removeLast()
default ELEMENTTYPE	setFirst(ELEMENTTYPE aNewElement)
default ELEMENTTYPE	setLast(ELEMENTTYPE aNewElement)

Methods inherited from interface java.util.List

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

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

addAll, addAll, addAll, addAll, addAllMapped, addAllMapped, addIf, addIfNotNull, containsAny, containsNone, containsOnly, findAll, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, getAtIndex, getAtIndex, getAtIndex, getAtIndexMapped, getAtIndexMapped, getCopyAsList, getCount, getSorted, isNotEmpty, iterator2, removeAll, set, setAll, setAll

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

getClone

Method Detail

createInstance

@Nonnull
 @ReturnsMutableCopy
default <T> ICommonsList<T> createInstance()

Create a new empty list. Overwrite this if you don't want to use CommonsArrayList.

Type Parameters:

T - List element type

Returns:

A new empty list. Never null.

getAll

@Nonnull
 @ReturnsMutableCopy
default ICommonsList<ELEMENTTYPE> getAll(@Nullable
                                                                         Predicate<? super ELEMENTTYPE> aFilter)

getAllMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> ICommonsList<DSTTYPE> getAllMapped(@Nonnull
                                                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper)

getAllMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> ICommonsList<DSTTYPE> getAllMapped(@Nullable
                                                                                     Predicate<? super ELEMENTTYPE> aFilter,
                                                                                     @Nonnull
                                                                                     Function<? super ELEMENTTYPE,DSTTYPE> aMapper)

getAllInstanceOf

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE extends ELEMENTTYPE> ICommonsList<DSTTYPE> getAllInstanceOf(@Nonnull
                                                                                                             Class<DSTTYPE> aDstClass)

getFirst

@Nullable
default ELEMENTTYPE getFirst()

getLast

@Nullable
default ELEMENTTYPE getLast()

getAtIndex

@Nullable
default ELEMENTTYPE getAtIndex(@Nonnegative
                                          int nIndex,
                                          @Nullable
                                          ELEMENTTYPE aDefault)

Safe list element accessor method.

Specified by:

getAtIndex in interface ICommonsCollection<ELEMENTTYPE>

Parameters:

nIndex - The index to access. Should be ≥ 0.

aDefault - The value to be returned, if the index is out of bounds.

Returns:

The default parameter if the element cannot be accessed.

setFirst

@Nullable
default ELEMENTTYPE setFirst(@Nullable
                                        ELEMENTTYPE aNewElement)

setLast

@Nullable
default ELEMENTTYPE setLast(@Nullable
                                       ELEMENTTYPE aNewElement)

removeAtIndex

@Nonnull
default EChange removeAtIndex(int nIndex)

Remove the element at the specified index from the passed list. This works if the list is not null and the index is ≥ 0 and < list.size()

Parameters:

nIndex - The index to be removed. May be arbitrary.

Returns:

EChange.CHANGED if removal was successful

See Also:

removeAndReturnElementAtIndex(int)

removeAndReturnElementAtIndex

@Nullable
default ELEMENTTYPE removeAndReturnElementAtIndex(int nIndex)

Remove the element at the specified index from the passed list. This works if the list is not null and the index is ≥ 0 and < list.size()

Parameters:

nIndex - The index to be removed. May be arbitrary.

Returns:

null if removal failed or the removed element. Note: the removed element may also be null so it may be tricky to determine if removal succeeded or not!

See Also:

removeAtIndex(int)

removeFirst

@Nullable
default ELEMENTTYPE removeFirst()

removeLast

@Nullable
default ELEMENTTYPE removeLast()

getAsUnmodifiable

@Nonnull
default List<ELEMENTTYPE> getAsUnmodifiable()

Specified by:

getAsUnmodifiable in interface ICommonsCollection<ELEMENTTYPE>