de.mrapp.util.datastructure

Class SortedArraySet<T>

java.lang.Object

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

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>, java.util.SortedSet<T>

public class SortedArraySet<T>
extends java.lang.Object
implements java.util.SortedSet<T>

A set, whose items are sorted based on a specific Comparator or according to their implementation of the interface Comparable. In contrast to a TreeSet, two items are considered as duplicates, if their hash codes are equal, instead of evaluating the result of the Comparator or Comparable.compareTo(Object) method. The set internally uses a SortedArrayList to keep the items in a sorted order whenever updated. In addition the hash codes of all items, which are contained by the set, are maintained in a HashSet to prevent duplicates from being added to the set.

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
SortedArraySet() Creates a new set, whose items are sorted.
SortedArraySet(java.util.Collection<T> items) Creates a new set, whose items are sorted.
SortedArraySet(@NotNull java.util.Collection<T> items, @Nullable java.util.Comparator<? super T> comparator) Creates a new set, whose items are sorted.
SortedArraySet(@Nullable java.util.Comparator<? super T> comparator) Creates a new set, whose items are sorted.
SortedArraySet(int initialCapacity) Creates a new set, whose items are sorted.
SortedArraySet(int initialCapacity, @Nullable java.util.Comparator<? super T> comparator) Creates a new set, whose items are sorted.

Method Summary

Modifier and Type	Method and Description
boolean	add(T item)
boolean	addAll(@NotNull java.util.Collection<? extends T> items)
void	clear()
@Nullable java.util.Comparator<? super T>	comparator()
boolean	contains(@NotNull java.lang.Object item)
boolean	containsAll(@NotNull java.util.Collection<?> items)
boolean	equals(java.lang.Object obj)
T	first()
int	hashCode()
@NotNull java.util.SortedSet<T>	headSet(T toElement)
boolean	isEmpty()
@NotNull java.util.Iterator<T>	iterator()
T	last()
boolean	remove(@NotNull java.lang.Object item)
boolean	removeAll(@NotNull java.util.Collection<?> items)
boolean	retainAll(@NotNull java.util.Collection<?> items)
int	size()
@NotNull java.util.SortedSet<T>	subSet(T fromElement, T toElement)
@NotNull java.util.SortedSet<T>	tailSet(T fromElement)
@NotNull java.lang.Object[]	toArray()
<T1> T1[]	toArray(T1[] array)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SortedArraySet

public SortedArraySet()

Creates a new set, whose items are sorted. By default, the items are sorted according to their implementation of the interface Comparable.

SortedArraySet

public SortedArraySet(java.util.Collection<T> items)

Creates a new set, whose items are sorted. By default, the items are sorted according to their implementation of the interface Comparable.

Parameters:

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

SortedArraySet

public SortedArraySet(int initialCapacity)

Creates a new set, whose items are sorted. By default, the items are sorted according to their implementation of the interface Comparable.

Parameters:

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

SortedArraySet

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

Creates a new set, whose items are sorted.

Parameters:

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

SortedArraySet

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

Creates a new set, whose items are sorted. By default, the items are sorted according to their implementation of the interface Comparable.

Parameters:

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

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

SortedArraySet

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

Creates a new set, whose items are sorted.

Parameters:

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

comparator - The comparator, which should be used to sort the set'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()

Specified by:

comparator in interface java.util.SortedSet<T>

subSet

@NotNull
public @NotNull java.util.SortedSet<T> subSet(@NotNull
                                                       T fromElement,
                                                       @NotNull
                                                       T toElement)

Specified by:

subSet in interface java.util.SortedSet<T>

headSet

@NotNull
public @NotNull java.util.SortedSet<T> headSet(@NotNull
                                                        T toElement)

Specified by:

headSet in interface java.util.SortedSet<T>

tailSet

@NotNull
public @NotNull java.util.SortedSet<T> tailSet(@NotNull
                                                        T fromElement)

Specified by:

tailSet in interface java.util.SortedSet<T>

first

@NotNull
public T first()

Specified by:

first in interface java.util.SortedSet<T>

last

@NotNull
public T last()

Specified by:

last in interface java.util.SortedSet<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.Set<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.Set<T>

contains

public boolean contains(@NotNull
                        @NotNull java.lang.Object item)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Set<T>

iterator

@NotNull
public @NotNull java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Set<T>

toArray

@NotNull
public @NotNull java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

toArray

@NotNull
public <T1> T1[] toArray(@NotNull
                                  T1[] array)

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.Set<T>

add

public boolean add(@NotNull
                   T item)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

remove

public boolean remove(@NotNull
                      @NotNull java.lang.Object item)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Set<T>

containsAll

public boolean containsAll(@NotNull
                           @NotNull java.util.Collection<?> items)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.Set<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.Set<T>

retainAll

public boolean retainAll(@NotNull
                         @NotNull java.util.Collection<?> items)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.Set<T>

removeAll

public boolean removeAll(@NotNull
                         @NotNull java.util.Collection<?> items)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.Set<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.Set<T>

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.Set<T>

Overrides:

equals in class java.lang.Object