Package com.cedarsoftware.util

Class ConcurrentNavigableSetNullSafe<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

com.cedarsoftware.util.ConcurrentNavigableSetNullSafe<E>

Type Parameters:

E - The type of elements maintained by this set

All Implemented Interfaces:

Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>

public class ConcurrentNavigableSetNullSafe<E>
extends AbstractSet<E>
implements NavigableSet<E>

ConcurrentNavigableSetNullSafe is a thread-safe implementation of NavigableSet that allows null elements by using a unique sentinel value internally.

Author:

John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

License

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor	Description
ConcurrentNavigableSetNullSafe()	Constructs a new, empty ConcurrentNavigableSetNullSafe with natural ordering of its elements.
ConcurrentNavigableSetNullSafe(Collection<? extends E> c)	Constructs a new ConcurrentNavigableSetNullSafe containing the elements in the specified collection.
ConcurrentNavigableSetNullSafe(Collection<? extends E> c, Comparator<? super E> comparator)	Constructs a new ConcurrentNavigableSetNullSafe containing the elements in the specified collection, ordered according to the provided comparator.
ConcurrentNavigableSetNullSafe(Comparator<? super E> comparator)	Constructs a new, empty ConcurrentNavigableSetNullSafe with the specified comparator.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
E	ceiling(E e)
void	clear()
Comparator<? super E>	comparator()
boolean	contains(Object o)
Iterator<E>	descendingIterator()
NavigableSet<E>	descendingSet()
E	first()
E	floor(E e)
SortedSet<E>	headSet(E toElement)
NavigableSet<E>	headSet(E toElement, boolean inclusive)
E	higher(E e)
boolean	isEmpty()
Iterator<E>	iterator()
E	last()
E	lower(E e)
E	pollFirst()
E	pollLast()
boolean	remove(Object o)
int	size()
NavigableSet<E>	subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
SortedSet<E>	subSet(E fromElement, E toElement)
SortedSet<E>	tailSet(E fromElement)
NavigableSet<E>	tailSet(E fromElement, boolean inclusive)

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details

ConcurrentNavigableSetNullSafe

public ConcurrentNavigableSetNullSafe()

Constructs a new, empty ConcurrentNavigableSetNullSafe with natural ordering of its elements. All elements inserted must implement the Comparable interface.

ConcurrentNavigableSetNullSafe

public ConcurrentNavigableSetNullSafe(Comparator<? super E> comparator)

Constructs a new, empty ConcurrentNavigableSetNullSafe with the specified comparator.

Parameters:

comparator - the comparator that will be used to order this set. If null, the natural ordering of the elements will be used.

ConcurrentNavigableSetNullSafe

public ConcurrentNavigableSetNullSafe(Collection<? extends E> c)

Constructs a new ConcurrentNavigableSetNullSafe containing the elements in the specified collection.

Parameters:

c - the collection whose elements are to be placed into this set

Throws:

NullPointerException - if the specified collection is null

ConcurrentNavigableSetNullSafe

public ConcurrentNavigableSetNullSafe(Collection<? extends E> c,
 Comparator<? super E> comparator)

Constructs a new ConcurrentNavigableSetNullSafe containing the elements in the specified collection, ordered according to the provided comparator.

Parameters:

c - the collection whose elements are to be placed into this set

comparator - the comparator that will be used to order this set. If null, the natural ordering of the elements will be used.

Throws:

NullPointerException - if the specified collection is null

Method Details

comparator

public Comparator<? super E> comparator()

Specified by:

comparator in interface SortedSet<E>

lower

public E lower(E e)

Specified by:

lower in interface NavigableSet<E>

floor

public E floor(E e)

Specified by:

floor in interface NavigableSet<E>

ceiling

public E ceiling(E e)

Specified by:

ceiling in interface NavigableSet<E>

higher

public E higher(E e)

Specified by:

higher in interface NavigableSet<E>

pollFirst

public E pollFirst()

Specified by:

pollFirst in interface NavigableSet<E>

pollLast

public E pollLast()

Specified by:

pollLast in interface NavigableSet<E>

iterator

public Iterator<E> iterator()

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 Set<E>

Specified by:

iterator in class AbstractCollection<E>

descendingSet

public NavigableSet<E> descendingSet()

Specified by:

descendingSet in interface NavigableSet<E>

descendingIterator

public Iterator<E> descendingIterator()

Specified by:

descendingIterator in interface NavigableSet<E>

subSet

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

Specified by:

subSet in interface NavigableSet<E>

headSet

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

Specified by:

headSet in interface NavigableSet<E>

tailSet

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

Specified by:

tailSet in interface NavigableSet<E>

subSet

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

Specified by:

subSet in interface NavigableSet<E>

Specified by:

subSet in interface SortedSet<E>

headSet

public SortedSet<E> headSet(E toElement)

Specified by:

headSet in interface NavigableSet<E>

Specified by:

headSet in interface SortedSet<E>

tailSet

public SortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface NavigableSet<E>

Specified by:

tailSet in interface SortedSet<E>

first

public E first()

Specified by:

first in interface SortedSet<E>

last

public E last()

Specified by:

last in interface SortedSet<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

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>

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>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>