ObjectRBTreeSet (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractCollection<T>
- - speiger.src.collections.objects.collections.AbstractObjectCollection<T>
  - - speiger.src.collections.objects.sets.AbstractObjectSet<T>
    - - speiger.src.collections.objects.sets.ObjectRBTreeSet<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.NavigableSet<T>, java.util.Set<T>, java.util.SortedSet<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectNavigableSet<T>, ObjectSet<T>, ObjectSortedSet<T>
```
public class ObjectRBTreeSet<T>
extends AbstractObjectSet<T>
implements ObjectNavigableSet<T>
```
A Simple Type Specific RB TreeSet implementation that reduces boxing/unboxing. It is using a bit more memory then FastUtil, but it saves a lot of Performance on the Optimized removal and iteration logic. Which makes the implementation actually useable and does not get outperformed by Javas default implementation.

Constructor Summary

Constructors
Constructor and Description
`ObjectRBTreeSet()` Default Constructor
`ObjectRBTreeSet(java.util.Collection<? extends T> collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectRBTreeSet(java.util.Collection<? extends T> collection, java.util.Comparator<T> comp)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectRBTreeSet(java.util.Comparator<T> comp)` Constructor that allows to define the sorter
`ObjectRBTreeSet(java.util.Iterator<T> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ObjectRBTreeSet(java.util.Iterator<T> iterator, java.util.Comparator<T> comp)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ObjectRBTreeSet(ObjectCollection<T> collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectRBTreeSet(ObjectCollection<T> collection, java.util.Comparator<T> comp)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`ObjectRBTreeSet(ObjectIterator<T> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ObjectRBTreeSet(ObjectIterator<T> iterator, java.util.Comparator<T> comp)` A Helper constructor that allows to create a set from a iterator of an unknown size
`ObjectRBTreeSet(ObjectSortedSet<T> sortedSet)` A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.
`ObjectRBTreeSet(T[] array)` Helper constructor that allow to create a set from an array
`ObjectRBTreeSet(T[] array, java.util.Comparator<T> comp)` Helper constructor that allow to create a set from an array
`ObjectRBTreeSet(T[] array, int offset, int length)` Helper constructor that allow to create a set from an array
`ObjectRBTreeSet(T[] array, int offset, int length, java.util.Comparator<T> comp)` Helper constructor that allow to create a set from an array

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T o)`
`T`	`addOrGet(T o)` A Helper method that allows to add a element or getting the already present implement.
`T`	`ceiling(T e)`
`void`	`clear()`
`java.util.Comparator<T>`	`comparator()` A Type Specific Comparator method
`boolean`	`contains(java.lang.Object e)`
`ObjectRBTreeSet<T>`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to count the valid elements.
`ObjectBidirectionalIterator<T>`	`descendingIterator()`
`ObjectNavigableSet<T>`	`descendingSet()`
`T`	`findFirst(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for the first match.
`T`	`first()`
`T`	`floor(T e)`
`void`	`forEach(java.util.function.Consumer<? super T> action)`
`<E> void`	`forEach(E input, ObjectObjectConsumer<E,T> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`T`	`getDefaultMaxValue()` only used for primitives
`T`	`getDefaultMinValue()` only used for primitives
`ObjectNavigableSet<T>`	`headSet(T toElement, boolean inclusive)`
`T`	`higher(T e)`
`ObjectBidirectionalIterator<T>`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`ObjectBidirectionalIterator<T>`	`iterator(T fromElement)` A type Specific Iterator starting from a given key
`T`	`last()`
`T`	`lower(T e)`
`boolean`	`matchesAll(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Object2BooleanFunction<T> filter)` Helper function to reduce stream usage that allows to filter for no matches.
`T`	`pollFirst()` A method to get and remove the first element in the set
`T`	`pollLast()` A method to get and remove the last element in the set
`<E> E`	`reduce(E identity, java.util.function.BiFunction<E,T,E> operator)` Performs a reduction on the elements of this Iterable
`T`	`reduce(ObjectObjectUnaryOperator<T,T> operator)` Performs a reduction on the elements of this Iterable
`boolean`	`remove(java.lang.Object o)`
`int`	`size()`
`ObjectNavigableSet<T>`	`subSet(T fromElement, boolean fromInclusive, T toElement, boolean toInclusive)`
`ObjectNavigableSet<T>`	`tailSet(T fromElement, boolean inclusive)`

Methods inherited from class speiger.src.collections.objects.sets.AbstractObjectSet
equals, hashCode

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection
addAll, containsAll, containsAll, containsAny, containsAny, removeAll, removeAll, retainAll, retainAll

Methods inherited from class java.util.AbstractCollection
addAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.sets.ObjectNavigableSet
headSet, spliterator, subSet, synchronize, synchronize, tailSet, unmodifiable

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection
addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, pour, removeAll, removeAll, retainAll, retainAll, toArray

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable
arrayflatMap, asAsync, distinct, filter, flatMap, limit, map, peek, pourAsList, pourAsSet, sorted

Methods inherited from interface java.util.Set
addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

- Constructor Detail
  - ObjectRBTreeSet
```
public ObjectRBTreeSet()
```
    Default Constructor
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(java.util.Comparator<T> comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(T[] array)
```
    Helper constructor that allow to create a set from an array
    
    Parameters:
    
    array - the elements that should be used
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(T[] array,
                       int offset,
                       int length)
```
    Helper constructor that allow to create a set from an array
    
    Parameters:
    
    array - the elements that should be used
    
    offset - the starting index within the array
    
    length - the amount of elements that are within the array
    
    Throws:
    
    java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(T[] array,
                       java.util.Comparator<T> comp)
```
    Helper constructor that allow to create a set from an array
    
    Parameters:
    
    array - the elements that should be used
    
    comp - the sorter of the tree, can be null
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(T[] array,
                       int offset,
                       int length,
                       java.util.Comparator<T> comp)
```
    Helper constructor that allow to create a set from an array
    
    Parameters:
    
    array - the elements that should be used
    
    offset - the starting index within the array
    
    length - the amount of elements that are within the array
    
    comp - the sorter of the tree, can be null
    
    Throws:
    
    java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(ObjectSortedSet<T> sortedSet)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided SortedSet.
    
    Parameters:
    
    sortedSet - the set the elements should be added to the TreeSet
    
    Note:
    
    this also includes the Comparator if present
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(java.util.Collection<? extends T> collection)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the TreeSet
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(java.util.Collection<? extends T> collection,
                       java.util.Comparator<T> comp)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the TreeSet
    
    comp - the sorter of the tree, can be null
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(ObjectCollection<T> collection)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the TreeSet
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(ObjectCollection<T> collection,
                       java.util.Comparator<T> comp)
```
    A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
    
    Parameters:
    
    collection - the set the elements should be added to the TreeSet
    
    comp - the sorter of the tree, can be null
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(java.util.Iterator<T> iterator)
```
    A Helper constructor that allows to create a set from a iterator of an unknown size
    
    Parameters:
    
    iterator - the elements that should be added to the set
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(java.util.Iterator<T> iterator,
                       java.util.Comparator<T> comp)
```
    A Helper constructor that allows to create a set from a iterator of an unknown size
    
    Parameters:
    
    iterator - the elements that should be added to the set
    
    comp - the sorter of the tree, can be null
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(ObjectIterator<T> iterator)
```
    A Helper constructor that allows to create a set from a iterator of an unknown size
    
    Parameters:
    
    iterator - the elements that should be added to the set
  - ObjectRBTreeSet
```
public ObjectRBTreeSet(ObjectIterator<T> iterator,
                       java.util.Comparator<T> comp)
```
    A Helper constructor that allows to create a set from a iterator of an unknown size
    
    Parameters:
    
    iterator - the elements that should be added to the set
    
    comp - the sorter of the tree, can be null
- Method Detail
  - getDefaultMaxValue
```
public T getDefaultMaxValue()
```
    only used for primitives
    
    Returns:
    
    null
  - getDefaultMinValue
```
public T getDefaultMinValue()
```
    only used for primitives
    
    Returns:
    
    null
  - add
```
public boolean add(T o)
```
    Specified by:
    
    add in interface java.util.Collection<T>
    
    Specified by:
    
    add in interface java.util.Set<T>
    
    Overrides:
    
    add in class java.util.AbstractCollection<T>
  - addOrGet
```
public T addOrGet(T o)
```
    Description copied from interface: ObjectSet
    
    A Helper method that allows to add a element or getting the already present implement. Allowing to make unique references reuseable.
    
    Specified by:
    
    addOrGet in interface ObjectSet<T>
    
    Overrides:
    
    addOrGet in class AbstractObjectSet<T>
    
    Parameters:
    
    o - the element to add
    
    Returns:
    
    either the inserted element or the present element.
  - lower
```
public T lower(T e)
```
    Specified by:
    
    lower in interface java.util.NavigableSet<T>
  - floor
```
public T floor(T e)
```
    Specified by:
    
    floor in interface java.util.NavigableSet<T>
  - higher
```
public T higher(T e)
```
    Specified by:
    
    higher in interface java.util.NavigableSet<T>
  - ceiling
```
public T ceiling(T e)
```
    Specified by:
    
    ceiling in interface java.util.NavigableSet<T>
  - forEach
```
public void forEach(java.util.function.Consumer<? super T> action)
```
    Specified by:
    
    forEach in interface java.lang.Iterable<T>
  - forEach
```
public <E> void forEach(E input,
                        ObjectObjectConsumer<E,T> action)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ObjectIterable<T>
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
  - matchesAny
```
public boolean matchesAny(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - reduce
```
public <E> E reduce(E identity,
                    java.util.function.BiFunction<E,T,E> operator)
```
    Description copied from interface: ObjectIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ObjectIterable<T>
    
    Type Parameters:
    
    E - the type of elements maintained by this Collection
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public T reduce(ObjectObjectUnaryOperator<T,T> operator)
```
    Description copied from interface: ObjectIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ObjectIterable<T>
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - findFirst
```
public T findFirst(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - count
```
public int count(Object2BooleanFunction<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - contains
```
public boolean contains(java.lang.Object e)
```
    Specified by:
    
    contains in interface java.util.Collection<T>
    
    Specified by:
    
    contains in interface java.util.Set<T>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<T>
  - first
```
public T first()
```
    Specified by:
    
    first in interface java.util.SortedSet<T>
  - last
```
public T last()
```
    Specified by:
    
    last in interface java.util.SortedSet<T>
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection<T>
    
    Specified by:
    
    remove in interface java.util.Set<T>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<T>
  - pollFirst
```
public T pollFirst()
```
    Description copied from interface: ObjectSortedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirst in interface java.util.NavigableSet<T>
    
    Specified by:
    
    pollFirst in interface ObjectSortedSet<T>
    
    Returns:
    
    first element in the set
  - pollLast
```
public T pollLast()
```
    Description copied from interface: ObjectSortedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLast in interface java.util.NavigableSet<T>
    
    Specified by:
    
    pollLast in interface ObjectSortedSet<T>
    
    Returns:
    
    last element in the set
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<T>
    
    Specified by:
    
    size in interface java.util.Set<T>
    
    Specified by:
    
    size in class java.util.AbstractCollection<T>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<T>
    
    Specified by:
    
    clear in interface java.util.Set<T>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<T>
  - copy
```
public ObjectRBTreeSet<T> copy()
```
    Description copied from interface: ObjectCollection
    
    A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface ObjectCollection<T>
    
    Specified by:
    
    copy in interface ObjectNavigableSet<T>
    
    Specified by:
    
    copy in interface ObjectSet<T>
    
    Specified by:
    
    copy in interface ObjectSortedSet<T>
    
    Overrides:
    
    copy in class AbstractObjectSet<T>
    
    Returns:
    
    a Shallow Copy of the collection
  - comparator
```
public java.util.Comparator<T> comparator()
```
    Description copied from interface: ObjectSortedSet
    
    A Type Specific Comparator method
    
    Specified by:
    
    comparator in interface java.util.SortedSet<T>
    
    Specified by:
    
    comparator in interface ObjectSortedSet<T>
    
    Returns:
    
    the type specific comparator
  - iterator
```
public ObjectBidirectionalIterator<T> iterator()
```
    Description copied from interface: ObjectCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    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.NavigableSet<T>
    
    Specified by:
    
    iterator in interface java.util.Set<T>
    
    Specified by:
    
    iterator in interface ObjectCollection<T>
    
    Specified by:
    
    iterator in interface ObjectIterable<T>
    
    Specified by:
    
    iterator in interface ObjectNavigableSet<T>
    
    Specified by:
    
    iterator in interface ObjectSet<T>
    
    Specified by:
    
    iterator in interface ObjectSortedSet<T>
    
    Specified by:
    
    iterator in class AbstractObjectSet<T>
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
public ObjectBidirectionalIterator<T> iterator(T fromElement)
```
    Description copied from interface: ObjectSortedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface ObjectSortedSet<T>
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - descendingIterator
```
public ObjectBidirectionalIterator<T> descendingIterator()
```
    Specified by:
    
    descendingIterator in interface java.util.NavigableSet<T>
    
    Specified by:
    
    descendingIterator in interface ObjectNavigableSet<T>
    
    Returns:
    
    a Type Specific desendingIterator
  - subSet
```
public ObjectNavigableSet<T> subSet(T fromElement,
                                    boolean fromInclusive,
                                    T toElement,
                                    boolean toInclusive)
```
    Specified by:
    
    subSet in interface java.util.NavigableSet<T>
    
    Specified by:
    
    subSet in interface ObjectNavigableSet<T>
  - headSet
```
public ObjectNavigableSet<T> headSet(T toElement,
                                     boolean inclusive)
```
    Specified by:
    
    headSet in interface java.util.NavigableSet<T>
    
    Specified by:
    
    headSet in interface ObjectNavigableSet<T>
  - tailSet
```
public ObjectNavigableSet<T> tailSet(T fromElement,
                                     boolean inclusive)
```
    Specified by:
    
    tailSet in interface java.util.NavigableSet<T>
    
    Specified by:
    
    tailSet in interface ObjectNavigableSet<T>
  - descendingSet
```
public ObjectNavigableSet<T> descendingSet()
```
    Specified by:
    
    descendingSet in interface java.util.NavigableSet<T>
    
    Specified by:
    
    descendingSet in interface ObjectNavigableSet<T>
    
    Returns:
    
    a Type Specific desendingSet

Class ObjectRBTreeSet<T>

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.sets.AbstractObjectSet

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.objects.sets.ObjectNavigableSet

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Constructor Detail

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

ObjectRBTreeSet

Method Detail

getDefaultMaxValue

getDefaultMinValue

add

addOrGet

lower

floor

higher

ceiling

forEach

forEach

matchesAny

matchesNone

matchesAll

reduce

reduce

findFirst

count

contains

first

last

remove

pollFirst

pollLast

size

clear

copy

comparator

iterator

iterator

descendingIterator

subSet

headSet

tailSet

descendingSet