Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection

Class MutableRedBlackSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.jhotdraw8.icollection.MutableRedBlackSet<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, NavigableSet<E>, SequencedCollection<E>, SequencedSet<E>, Set<E>, SortedSet<E>, ReadOnlyCollection<E>, ReadOnlyNavigableSet<E>, ReadOnlySequencedCollection<E>, ReadOnlySequencedSet<E>, ReadOnlySet<E>, ReadOnlySortedSet<E>

public class MutableRedBlackSet<E>
extends AbstractSet<E>
implements NavigableSet<E>, Serializable, Cloneable, ReadOnlyNavigableSet<E>

Implements the NavigableSet interface using a Red-Black tree.

References:

For a similar design, see 'TreeSet.java' in vavr. The internal data structure of this class is licensed from vavr.

TreeSet.java. Copyright 2023 (c) vavr. MIT License.

github.com

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	modCount	The number of times this set has been structurally modified.

Constructor Summary

Constructors

Constructor	Description
MutableRedBlackSet()	Constructs a new, empty set, sorted according to the natural ordering of its elements.
MutableRedBlackSet(Iterable<? extends E> c)	Constructs a new tree set containing the elements in the specified collection, sorted according to the natural ordering of its elements.
MutableRedBlackSet(@Nullable Comparator<E> comparator)	Constructs a new, empty set, sorted according to the specified comparator.
MutableRedBlackSet(@Nullable Comparator<E> comparator, Collection<? extends E> c)	Constructs a new tree set containing the elements in the specified collection, sorted according to the specified comparator.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
boolean	addAll(@NonNull Iterable<? extends E> c)
@Nullable E	ceiling(E e)	Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
void	clear()
MutableRedBlackSet<E>	clone()
@Nullable Comparator<? super E>	comparator()	Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
boolean	contains(Object o)	Returns true if this collection contains the specified object.
@NonNull Iterator<E>	descendingIterator()
@NonNull NavigableSet<E>	descendingSet()
E	first()
@Nullable E	floor(E e)	Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
E	getFirst()	Gets the first element.
E	getLast()	Gets the last element.
protected int	getModCount()	Returns the current value of the modification counter.
@NonNull SortedSet<E>	headSet(E toElement)
@NonNull NavigableSet<E>	headSet(E toElement, boolean inclusive)
@Nullable E	higher(E e)	Returns the least element in this set greater than the given element, or null if there is no such element.
boolean	isEmpty()	Returns true if the collection is empty.
@NonNull Iterator<E>	iterator()	Returns an iterator over the elements in this collection.
E	last()
@Nullable E	lower(E e)	Returns the greatest element in this set less than the given element, or null if there is no such element.
@Nullable E	pollFirst()
@Nullable E	pollLast()
@NonNull ReadOnlySequencedSet<E>	readOnlyReversed()	Returns a reversed-order view of this set.
boolean	remove(Object o)
int	size()	Returns the size of the collection.
Spliterator<E>	spliterator()
Stream<E>	stream()	Returns a stream.
@NonNull NavigableSet<E>	subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
@NonNull SortedSet<E>	subSet(E fromElement, E toElement)
@NonNull SortedSet<E>	tailSet(E fromElement)
@NonNull NavigableSet<E>	tailSet(E fromElement, boolean inclusive)
@NonNull RedBlackSet<E>	toImmutable()	Returns an immutable copy of this set.
String	toString()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.NavigableSet

removeFirst, removeLast, reversed

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlyCollection

containsAll, toArray, toArray

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySequencedCollection

asCollection

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySequencedSet

asSet

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlySet

characteristics, equals, hashCode

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.SortedSet

addFirst, addLast

Field Details

modCount

protected transient int modCount

The number of times this set has been structurally modified.

Constructor Details

MutableRedBlackSet

public MutableRedBlackSet(@Nullable Comparator<E> comparator)

Constructs a new, empty set, sorted according to the specified comparator.

Parameters:

comparator - a comparator, if null the natural ordering of the elements is used

MutableRedBlackSet

public MutableRedBlackSet(@Nullable Comparator<E> comparator,
 Collection<? extends E> c)

Constructs a new tree set containing the elements in the specified collection, sorted according to the specified comparator.

Parameters:

comparator - a comparator, if null the natural ordering of the elements is used

c - the collection

MutableRedBlackSet

public MutableRedBlackSet()

Constructs a new, empty set, sorted according to the natural ordering of its elements.

MutableRedBlackSet

public MutableRedBlackSet(Iterable<? extends E> c)

Constructs a new tree set containing the elements in the specified collection, sorted according to the natural ordering of its elements.

Parameters:

c - the collection

Method Details

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

addAll

public boolean addAll(@NonNull Iterable<? extends E> c)

ceiling

public @Nullable E ceiling(E e)

Description copied from interface: ReadOnlyNavigableSet

Returns the least element in this set greater than or equal to the given element, or null if there is no such element.

Specified by:

ceiling in interface NavigableSet<E>

Specified by:

ceiling in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

ceiling element or null

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

clone

public MutableRedBlackSet<E> clone()

Overrides:

clone in class Object

comparator

public @Nullable Comparator<? super E> comparator()

Description copied from interface: ReadOnlySortedSet

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

Specified by:

comparator in interface ReadOnlySortedSet<E>

Specified by:

comparator in interface SortedSet<E>

Returns:

comparator or null

contains

public boolean contains(Object o)

Description copied from interface: ReadOnlyCollection

Returns true if this collection contains the specified object.

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface ReadOnlyCollection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

Parameters:

o - an object

Returns:

true if this collection contains the specified object

descendingIterator

public @NonNull Iterator<E> descendingIterator()

Specified by:

descendingIterator in interface NavigableSet<E>

descendingSet

public @NonNull NavigableSet<E> descendingSet()

Specified by:

descendingSet in interface NavigableSet<E>

first

public E first()

Specified by:

first in interface SortedSet<E>

floor

public @Nullable E floor(E e)

Description copied from interface: ReadOnlyNavigableSet

Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.

Specified by:

floor in interface NavigableSet<E>

Specified by:

floor in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

floor element or null

getFirst

public E getFirst()

Description copied from interface: ReadOnlySequencedCollection

Gets the first element.

Specified by:

getFirst in interface ReadOnlySequencedCollection<E>

Specified by:

getFirst in interface SequencedCollection<E>

Specified by:

getFirst in interface SortedSet<E>

Returns:

an element

getLast

public E getLast()

Description copied from interface: ReadOnlySequencedCollection

Gets the last element.

Specified by:

getLast in interface ReadOnlySequencedCollection<E>

Specified by:

getLast in interface SequencedCollection<E>

Specified by:

getLast in interface SortedSet<E>

Returns:

an element

getModCount

protected int getModCount()

Returns the current value of the modification counter.

Returns:

value of modification counter

headSet

public @NonNull NavigableSet<E> headSet(E toElement,
 boolean inclusive)

Specified by:

headSet in interface NavigableSet<E>

headSet

public @NonNull SortedSet<E> headSet(E toElement)

Specified by:

headSet in interface NavigableSet<E>

Specified by:

headSet in interface SortedSet<E>

higher

public @Nullable E higher(E e)

Description copied from interface: ReadOnlyNavigableSet

Returns the least element in this set greater than the given element, or null if there is no such element.

Specified by:

higher in interface NavigableSet<E>

Specified by:

higher in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

higher element or null

isEmpty

public boolean isEmpty()

Description copied from interface: ReadOnlyCollection

Returns true if the collection is empty.

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface ReadOnlyCollection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

Returns:

true if empty

iterator

public @NonNull Iterator<E> iterator()

Description copied from interface: ReadOnlyCollection

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface NavigableSet<E>

Specified by:

iterator in interface ReadOnlyCollection<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

Returns:

an iterator

last

public E last()

Specified by:

last in interface SortedSet<E>

lower

public @Nullable E lower(E e)

Description copied from interface: ReadOnlyNavigableSet

Returns the greatest element in this set less than the given element, or null if there is no such element.

Specified by:

lower in interface NavigableSet<E>

Specified by:

lower in interface ReadOnlyNavigableSet<E>

Parameters:

e - the given element

Returns:

lower element or null

pollFirst

public @Nullable E pollFirst()

Specified by:

pollFirst in interface NavigableSet<E>

pollLast

public @Nullable E pollLast()

Specified by:

pollLast in interface NavigableSet<E>

readOnlyReversed

public @NonNull ReadOnlySequencedSet<E> readOnlyReversed()

Description copied from interface: ReadOnlySequencedSet

Returns a reversed-order view of this set. Changes to the underlying set are visible in the reversed view.

Specified by:

readOnlyReversed in interface ReadOnlySequencedCollection<E>

Specified by:

readOnlyReversed in interface ReadOnlySequencedSet<E>

Returns:

a reversed-order view of this set

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

size

public int size()

Description copied from interface: ReadOnlyCollection

Returns the size of the collection.

Specified by:

size in interface Collection<E>

Specified by:

size in interface ReadOnlyCollection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

Returns:

the size

spliterator

public Spliterator<E> spliterator()

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

Specified by:

spliterator in interface Set<E>

Specified by:

spliterator in interface SortedSet<E>

stream

public Stream<E> stream()

Description copied from interface: ReadOnlyCollection

Returns a stream.

Specified by:

stream in interface Collection<E>

Specified by:

stream in interface ReadOnlyCollection<E>

Returns:

a stream

subSet

public @NonNull NavigableSet<E> subSet(E fromElement,
 boolean fromInclusive,
 E toElement,
 boolean toInclusive)

Specified by:

subSet in interface NavigableSet<E>

subSet

public @NonNull SortedSet<E> subSet(E fromElement,
 E toElement)

Specified by:

subSet in interface NavigableSet<E>

Specified by:

subSet in interface SortedSet<E>

tailSet

public @NonNull NavigableSet<E> tailSet(E fromElement,
 boolean inclusive)

Specified by:

tailSet in interface NavigableSet<E>

tailSet

public @NonNull SortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface NavigableSet<E>

Specified by:

tailSet in interface SortedSet<E>

toImmutable

public @NonNull RedBlackSet<E> toImmutable()

Returns an immutable copy of this set.

Returns:

an immutable copy

toString

public String toString()

Overrides:

toString in class AbstractCollection<E>