RedBlackTreeLong (lecousin.net Java core framework 0.16.2 API)

java.lang.Object
- net.lecousin.framework.collections.sort.RedBlackTreeLong<T>

Type Parameters:

T - type of elements

All Implemented Interfaces:

Iterable<T>, Sorted<T>, Sorted.AssociatedWithLong<T>
```
public class RedBlackTreeLong<T>
extends Object
implements Sorted.AssociatedWithLong<T>
```
Sorted list, where each element is associated with a long value used to compare elements. To sort the elements, a red-black tree is used.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RedBlackTreeLong.Node<T>
Node in the RedBlackTree.
- Nested classes/interfaces inherited from interface net.lecousin.framework.collections.sort.Sorted
  Sorted.AssociatedWithInteger<T>, Sorted.AssociatedWithLong<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`RedBlackTreeLong.Node<T>` Node in the RedBlackTree.

Constructor Summary

Constructors
Constructor and Description

RedBlackTreeLong()

Constructors
Constructor and Description
`RedBlackTreeLong()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(long value, T element)` Add an element.
`void`	`clear()` Clear this collection.
`boolean`	`contains(long value, T element)` Returns true if the given key exists in the tree and its associated value is the given element.
`boolean`	`containsInstance(long value, T instance)` Returns true if the given key exists in the tree and its associated value is the given element.
`boolean`	`containsKey(long value)` Returns true if the given key exists in the tree.
`RedBlackTreeLong.Node<T>`	`get(long value)` Returns the node associated to the given key, or null if no such key exists.
`RedBlackTreeLong.Node<T>`	`getMax()`
`RedBlackTreeLong.Node<T>`	`getMin()`
`RedBlackTreeLong.Node<T>`	`getNext(long value)` Returns the node containing the key just before the given key.
`RedBlackTreeLong.Node<T>`	`getNext(RedBlackTreeLong.Node<T> node)` Returns the node containing the key just before the key of the given node.
`RedBlackTreeLong.Node<T>`	`getPrevious(long value)` Returns the node containing the key just before the given key.
`RedBlackTreeLong.Node<T>`	`getPrevious(RedBlackTreeLong.Node<T> node)` Returns the node containing the key just before the key of the given node.
`boolean`	`isEmpty()` Return true if this collection is empty.
`Iterator<T>`	`iterator()`
`Iterator<RedBlackTreeLong.Node<T>>`	`nodeIterator()`
`Iterator<RedBlackTreeLong.Node<T>>`	`nodeIteratorOrdered()`
`Iterator<RedBlackTreeLong.Node<T>>`	`nodeIteratorReverse()`
`Iterator<T>`	`orderedIterator()` Return an iterator that iterates on the correct order.
`void`	`remove(long key, T element)` Remove the node containing the given key and element.
`void`	`remove(RedBlackTreeLong.Node<T> node)` Remove the given node.
`void`	`removeInstance(long key, T instance)` Remove the node containing the given key and element.
`void`	`removeKey(long key)` Remove the given key.
`void`	`removeMax()` Remove the last element.
`void`	`removeMin()` Remove the first element.
`Iterator<T>`	`reverseOrderIterator()` Return an iterator that iterates on the correct order.
`RedBlackTreeLong.Node<T>`	`searchNearestHigher(long value, boolean acceptEquals)` Returns the node containing the lowest value strictly higher than the given one.
`RedBlackTreeLong.Node<T>`	`searchNearestLower(long value, boolean acceptEquals)` Returns the node containing the highest value strictly lower than the given one.
`int`	`size()` Number of elements in this collection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - RedBlackTreeLong
```
public RedBlackTreeLong()
```
- Method Detail
  - size
```
public int size()
```
    Description copied from interface: Sorted
    
    Number of elements in this collection.
    
    Specified by:
    
    size in interface Sorted<T>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Sorted
    
    Return true if this collection is empty.
    
    Specified by:
    
    isEmpty in interface Sorted<T>
  - clear
```
public void clear()
```
    Description copied from interface: Sorted
    
    Clear this collection.
    
    Specified by:
    
    clear in interface Sorted<T>
  - get
```
public RedBlackTreeLong.Node<T> get(long value)
```
    Returns the node associated to the given key, or null if no such key exists.
  - getPrevious
```
public RedBlackTreeLong.Node<T> getPrevious(long value)
```
    Returns the node containing the key just before the given key.
  - getPrevious
```
public RedBlackTreeLong.Node<T> getPrevious(RedBlackTreeLong.Node<T> node)
```
    Returns the node containing the key just before the key of the given node.
  - getNext
```
public RedBlackTreeLong.Node<T> getNext(long value)
```
    Returns the node containing the key just before the given key.
  - getNext
```
public RedBlackTreeLong.Node<T> getNext(RedBlackTreeLong.Node<T> node)
```
    Returns the node containing the key just before the key of the given node.
  - containsKey
```
public boolean containsKey(long value)
```
    Returns true if the given key exists in the tree.
  - contains
```
public boolean contains(long value,
                        T element)
```
    Returns true if the given key exists in the tree and its associated value is the given element. Comparison of the element is using the equals method.
    
    Specified by:
    
    contains in interface Sorted.AssociatedWithLong<T>
  - containsInstance
```
public boolean containsInstance(long value,
                                T instance)
```
    Returns true if the given key exists in the tree and its associated value is the given element. Comparison of the element is using the == operator.
    
    Specified by:
    
    containsInstance in interface Sorted.AssociatedWithLong<T>
  - getMin
```
public RedBlackTreeLong.Node<T> getMin()
```
  - getMax
```
public RedBlackTreeLong.Node<T> getMax()
```
  - searchNearestLower
```
public RedBlackTreeLong.Node<T> searchNearestLower(long value,
                                                   boolean acceptEquals)
```
    Returns the node containing the highest value strictly lower than the given one.
  - searchNearestHigher
```
public RedBlackTreeLong.Node<T> searchNearestHigher(long value,
                                                    boolean acceptEquals)
```
    Returns the node containing the lowest value strictly higher than the given one.
  - add
```
public void add(long value,
                T element)
```
    Description copied from interface: Sorted.AssociatedWithLong
    
    Add an element.
    
    Specified by:
    
    add in interface Sorted.AssociatedWithLong<T>
  - removeMin
```
public void removeMin()
```
    Remove the first element.
  - removeMax
```
public void removeMax()
```
    Remove the last element.
  - remove
```
public void remove(RedBlackTreeLong.Node<T> node)
```
    Remove the given node.
  - remove
```
public void remove(long key,
                   T element)
```
    Remove the node containing the given key and element. The node MUST exists, else the tree won't be valid anymore.
    
    Specified by:
    
    remove in interface Sorted.AssociatedWithLong<T>
  - removeKey
```
public void removeKey(long key)
```
    Remove the given key. The key MUST exists, else the tree won't be valid anymore.
  - removeInstance
```
public void removeInstance(long key,
                           T instance)
```
    Remove the node containing the given key and element. The node MUST exists, else the tree won't be valid anymore.
    
    Specified by:
    
    removeInstance in interface Sorted.AssociatedWithLong<T>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - nodeIterator
```
public Iterator<RedBlackTreeLong.Node<T>> nodeIterator()
```
  - nodeIteratorOrdered
```
public Iterator<RedBlackTreeLong.Node<T>> nodeIteratorOrdered()
```
  - nodeIteratorReverse
```
public Iterator<RedBlackTreeLong.Node<T>> nodeIteratorReverse()
```
  - orderedIterator
```
public Iterator<T> orderedIterator()
```
    Description copied from interface: Sorted
    
    Return an iterator that iterates on the correct order.
    
    Specified by:
    
    orderedIterator in interface Sorted<T>
  - reverseOrderIterator
```
public Iterator<T> reverseOrderIterator()
```
    Description copied from interface: Sorted
    
    Return an iterator that iterates on the correct order.
    
    Specified by:
    
    reverseOrderIterator in interface Sorted<T>

Class RedBlackTreeLong<T>

Nested Class Summary

Nested classes/interfaces inherited from interface net.lecousin.framework.collections.sort.Sorted

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

RedBlackTreeLong

Method Detail

size

isEmpty

clear

get

getPrevious

getPrevious

getNext

getNext

containsKey

contains

containsInstance

getMin

getMax

searchNearestLower

searchNearestHigher

add

removeMin

removeMax

remove

remove

removeKey

removeInstance

iterator

nodeIterator

nodeIteratorOrdered

nodeIteratorReverse

orderedIterator

reverseOrderIterator