de.mrapp.util.datastructure

Class SortedArrayList<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

de.mrapp.util.datastructure.SortedArrayList<T>

Type Parameters:

T - The type of the items, which are contained by the list

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess

public class SortedArrayList<T>
extends java.util.ArrayList<T>

An extension of ArrayList, which automatically keeps its items in a sorted order, whenever new items are added. Such a list does not allow to add items at specific indices. Therefore an UnsupportedOperationException is thrown by the add(int, Object) and addAll(int, Collection) methods.

Since:

1.1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SortedArrayList() Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.
SortedArrayList(@NotNull java.util.Collection<? extends T> items) Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.
SortedArrayList(@NotNull java.util.Collection<? extends T> items, @Nullable java.util.Comparator<? super T> comparator) Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.
SortedArrayList(@Nullable java.util.Comparator<? super T> comparator) Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.
SortedArrayList(int initialCapacity) Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.
SortedArrayList(int initialCapacity, @Nullable java.util.Comparator<? super T> comparator) Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.

Method Summary

Modifier and Type	Method and Description
void	add(int index, T item)
boolean	add(T item)
boolean	addAll(@NotNull java.util.Collection<? extends T> items)
boolean	addAll(int index, @NotNull java.util.Collection<? extends T> items)
@Nullable java.util.Comparator<? super T>	comparator() Returns the comparator, which is used to sort the list's items.

Methods inherited from class java.util.ArrayList

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

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

SortedArrayList

public SortedArrayList()

Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added. By default, the items' implementation of the interface Comparable is used to sort the list's items.

SortedArrayList

public SortedArrayList(@NotNull
                       @NotNull java.util.Collection<? extends T> items)

Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added. By default, the items' implementation of the interface Comparable is used to sort the list's items.

Parameters:

items - A collection, which contains the items, which should be added to the list, as an instance of the type Collection or an empty list, if no items should be added

SortedArrayList

public SortedArrayList(int initialCapacity)

Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added. By default, the items' implementation of the interface Comparable is used to sort the list's items.

Parameters:

initialCapacity - The initial capacity of the list as an Integer value

SortedArrayList

public SortedArrayList(@Nullable
                       @Nullable java.util.Comparator<? super T> comparator)

Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.

Parameters:

comparator - The comparator, which should be used to sort the list's items, or null, if the items' implementation of the interface Comparable should be used instead

SortedArrayList

public SortedArrayList(@NotNull
                       @NotNull java.util.Collection<? extends T> items,
                       @Nullable
                       @Nullable java.util.Comparator<? super T> comparator)

Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.

Parameters:

items - A collection, which contains the items, which should be added to the list, as an instance of the type Collection or an empty list, if no items should be added

comparator - The comparator, which should be used to sort the list's items, or null, if the items' implementation of the interface Comparable should be used instead

SortedArrayList

public SortedArrayList(int initialCapacity,
                       @Nullable
                       @Nullable java.util.Comparator<? super T> comparator)

Creates a new list, which automatically keeps its items in a sorted order, whenever new items are added.

Parameters:

initialCapacity - The initial capacity of the list as an Integer value

comparator - The comparator, which should be used to sort the list's items, or null, if the items' implementation of the interface Comparable should be used instead

Method Detail

comparator

@Nullable
public @Nullable java.util.Comparator<? super T> comparator()

Returns the comparator, which is used to sort the list's items.

Returns:

The comparator, which is used to sort the list's items, as an instance of the type Comparator or null, if the item's implementation of the interface Comparable is used

add

public boolean add(@NotNull
                   T item)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.List<T>

Overrides:

add in class java.util.ArrayList<T>

add

public void add(int index,
                @NotNull
                T item)

Specified by:

add in interface java.util.List<T>

Overrides:

add in class java.util.ArrayList<T>

addAll

public boolean addAll(@NotNull
                      @NotNull java.util.Collection<? extends T> items)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class java.util.ArrayList<T>

addAll

public boolean addAll(int index,
                      @NotNull
                      @NotNull java.util.Collection<? extends T> items)

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class java.util.ArrayList<T>