RBTNode (JOAFIP "Abstract" Parent Project 4.0.0b9)

java.lang.Object
- net.sf.joafip.redblacktree.impl.memory.entity.RBTNode<E>

Type Parameters:
E - type of the element hold by the red black tree node

All Implemented Interfaces:

Serializable, IRBTComparableNode<E>, IRBTNode<E>, IRBTVisitable<E>

Direct Known Subclasses:

TreeSupportNode
```
@StoreNotUseStandardSerialization
@StorableClass
public class RBTNode<E>
extends Object
implements IRBTNode<E>, Serializable
```
red black tree node

Author:

luc peuvrier

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Comparator<? super E>`	`comparator` the comparator used to compare the element of this node, or `null` if this node uses the natural comparator of its element
`protected E`	`element`

Constructor Summary

Constructors
Constructor and Description
`RBTNode()`
`RBTNode(Comparator<? super E> comparator)` construct a empty node
`RBTNode(E element)` a new node for an element
`RBTNode(E element, Comparator<? super E> comparator)` construct a empty node setting a comparator for this node element

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(IRBTVisitor<E> visitor)` accept red black tree visitor
`int`	`compareTo(E element)`
`int`	`compareTo(IRBTComparableNode<E> node)`
`void`	`decrementNumberOfChild()`
`void`	`detach()` detach the node from the tree
`boolean`	`equals(Object obj)`
`boolean`	`getColor()` get node color color definition: `RedBlackTree#BLACK` and `RedBlackTree#RED`
`E`	`getElement()` get the element of this node
`int`	`getIndex()`
`IRBTNode<E>`	`getLeft()` get left child of this node
`int`	`getNumberOfChild()` get the number of node in right and left tree node, sentinel excluded
`IRBTNode<E>`	`getParent()` get parent node
`IRBTNode<E>`	`getRight()` get right child of this node
`int`	`hashCode()`
`void`	`incrementNumberOfChild()`
`boolean`	`isAttached()`
`boolean`	`isBlack()` to know if node is black
`boolean`	`isColorSetted()`
`boolean`	`isRed()` to know if node is red
`boolean`	`isSentinel()` to know if this node is a sentinel ( a black leaf marker ), if not a sentinel it is a valued node with right and left child
`static RBTNode`	`newInstance(IInstanceFactory instanceFactory)`
`static RBTNode`	`newInstance(IInstanceFactory instanceFactory, Comparator comparator)`
`static RBTNode`	`newInstance(IInstanceFactory instanceFactory, Object element)`
`static RBTNode`	`newInstance(IInstanceFactory instanceFactory, Object element, Comparator comparator)`
`void`	`setBlack()` set node color to black
`void`	`setColor(boolean color)` set node color color definition: `RedBlackTree#BLACK` and `RedBlackTree#RED`
`void`	`setElement(E element)` set this node element
`void`	`setIndex(int index)`
`void`	`setLeft(IRBTNode<E> node)` set left child of this node
`void`	`setNumberOfChild(int numberOfChild)` set the number of node in right and left tree node, sentinel excluded
`void`	`setParent(IRBTNode<E> node)` set parent node
`void`	`setRed()` set node color to red
`void`	`setRight(IRBTNode<E> node)` set right child of this node
`String`	`toString()`

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

- Field Detail
  - element
```
protected E element
```
  - comparator
```
protected final Comparator<? super E> comparator
```
    the comparator used to compare the element of this node, or null if this node uses the natural comparator of its element
- Constructor Detail
  - RBTNode
```
public RBTNode()
```
  - RBTNode
```
public RBTNode(Comparator<? super E> comparator)
```
    construct a empty node
    
    Parameters:
    comparator - the comparator to use on this node element
  - RBTNode
```
public RBTNode(E element)
```
    a new node for an element
    
    Parameters:
    element - element of this node
  - RBTNode
```
public RBTNode(E element,
       Comparator<? super E> comparator)
```
    construct a empty node setting a comparator for this node element
    
    Parameters:
    element - element of this node
    comparator - the comparator to use on this node element
- Method Detail
  - newInstance
```
public static RBTNode newInstance(IInstanceFactory instanceFactory)
```
  - newInstance
```
public static RBTNode newInstance(IInstanceFactory instanceFactory,
                  Comparator comparator)
```
  - newInstance
```
public static RBTNode newInstance(IInstanceFactory instanceFactory,
                  Object element)
```
  - newInstance
```
public static RBTNode newInstance(IInstanceFactory instanceFactory,
                  Object element,
                  Comparator comparator)
```
  - isColorSetted
```
public boolean isColorSetted()
```
    Specified by:
    
    isColorSetted in interface IRBTNode<E>
    
    Returns:
    true if node color is set
  - isBlack
```
public boolean isBlack()
                throws RBTException
```
    Description copied from interface: IRBTNode
    
    to know if node is black
    
    Specified by:
    
    isBlack in interface IRBTNode<E>
    
    Returns:
    true if node is black
    
    Throws:
    
    RBTException - node access error
  - setBlack
```
public void setBlack()
              throws RBTException
```
    Description copied from interface: IRBTNode
    
    set node color to black
    
    Specified by:
    
    setBlack in interface IRBTNode<E>
    
    Throws:
    
    RBTException
  - isRed
```
public boolean isRed()
              throws RBTException
```
    Description copied from interface: IRBTNode
    
    to know if node is red
    
    Specified by:
    
    isRed in interface IRBTNode<E>
    
    Returns:
    true if node is red
    
    Throws:
    
    RBTException - node access error
  - setRed
```
public void setRed()
            throws RBTException
```
    Description copied from interface: IRBTNode
    
    set node color to red
    
    Specified by:
    
    setRed in interface IRBTNode<E>
    
    Throws:
    
    RBTException - node access error
  - getParent
```
public IRBTNode<E> getParent()
                      throws RBTException
```
    Description copied from interface: IRBTNode
    
    get parent node
    
    Specified by:
    
    getParent in interface IRBTNode<E>
    
    Returns:
    the parent node, or null if have not ( this is root node )
    
    Throws:
    
    RBTException - node access error
  - setParent
```
public void setParent(IRBTNode<E> node)
               throws RBTException
```
    Description copied from interface: IRBTNode
    
    set parent node
    
    Specified by:
    
    setParent in interface IRBTNode<E>
    
    Parameters:
    node - the parent node
    
    Throws:
    
    RBTException - node access error
  - getLeft
```
public IRBTNode<E> getLeft()
                    throws RBTException
```
    Description copied from interface: IRBTNode
    
    get left child of this node
    
    Specified by:
    
    getLeft in interface IRBTNode<E>
    
    Returns:
    left child of this node
    
    Throws:
    
    RBTException - node access error
  - setLeft
```
public void setLeft(IRBTNode<E> node)
             throws RBTException
```
    Description copied from interface: IRBTNode
    
    set left child of this node
    
    Specified by:
    
    setLeft in interface IRBTNode<E>
    
    Parameters:
    node - the left child of this node
    
    Throws:
    
    RBTException - node access error
  - getRight
```
public IRBTNode<E> getRight()
                     throws RBTException
```
    Description copied from interface: IRBTNode
    
    get right child of this node
    
    Specified by:
    
    getRight in interface IRBTNode<E>
    
    Returns:
    right child of this node
    
    Throws:
    
    RBTException - node access error
  - setRight
```
public void setRight(IRBTNode<E> node)
              throws RBTException
```
    Description copied from interface: IRBTNode
    
    set right child of this node
    
    Specified by:
    
    setRight in interface IRBTNode<E>
    
    Parameters:
    node - the right child of this node
    
    Throws:
    
    RBTException - node access error
  - getElement
```
public E getElement()
```
    Description copied from interface: IRBTNode
    
    get the element of this node
    
    Specified by:
    
    getElement in interface IRBTNode<E>
    
    Returns:
    the element of this node
  - setElement
```
public void setElement(E element)
```
    Description copied from interface: IRBTNode
    
    set this node element
    
    Specified by:
    
    setElement in interface IRBTNode<E>
    
    Parameters:
    element - the element to set for this node
  - isSentinel
```
public boolean isSentinel()
                   throws RBTException
```
    Description copied from interface: IRBTNode
    
    to know if this node is a sentinel ( a black leaf marker ), if not a sentinel it is a valued node with right and left child
    
    Specified by:
    
    isSentinel in interface IRBTNode<E>
    
    Returns:
    true is this node is a sentinel
    
    Throws:
    
    RBTException - node access error
  - getColor
```
public boolean getColor()
                 throws RBTException
```
    Description copied from interface: IRBTNode
    
    get node color
    color definition: RedBlackTree#BLACK and RedBlackTree#RED
    
    Specified by:
    
    getColor in interface IRBTNode<E>
    
    Returns:
    the node color
    
    Throws:
    
    RBTException - node access error
  - setColor
```
public void setColor(boolean color)
              throws RBTException
```
    Description copied from interface: IRBTNode
    
    set node color
    color definition: RedBlackTree#BLACK and RedBlackTree#RED
    
    Specified by:
    
    setColor in interface IRBTNode<E>
    
    Parameters:
    color - the node color
    
    Throws:
    
    RBTException - node access error
  - getNumberOfChild
```
public int getNumberOfChild()
                     throws RBTException
```
    Description copied from interface: IRBTNode
    
    get the number of node in right and left tree node, sentinel excluded
    
    Specified by:
    
    getNumberOfChild in interface IRBTNode<E>
    
    Returns:
    the number of children
    
    Throws:
    
    RBTException - node access error
  - setNumberOfChild
```
public void setNumberOfChild(int numberOfChild)
                      throws RBTException
```
    Description copied from interface: IRBTNode
    
    set the number of node in right and left tree node, sentinel excluded
    
    Specified by:
    
    setNumberOfChild in interface IRBTNode<E>
    
    Parameters:
    numberOfChild - the number of children
    
    Throws:
    
    RBTException
  - setIndex
```
public void setIndex(int index)
```
    Specified by:
    
    setIndex in interface IRBTNode<E>
  - getIndex
```
public int getIndex()
```
    Specified by:
    
    getIndex in interface IRBTNode<E>
  - decrementNumberOfChild
```
public void decrementNumberOfChild()
                            throws RBTException
```
    Specified by:
    
    decrementNumberOfChild in interface IRBTNode<E>
    
    Throws:
    
    RBTException
  - incrementNumberOfChild
```
public void incrementNumberOfChild()
                            throws RBTException
```
    Specified by:
    
    incrementNumberOfChild in interface IRBTNode<E>
    
    Throws:
    
    RBTException
  - detach
```
public void detach()
```
    Description copied from interface: IRBTNode
    
    detach the node from the tree
    
    Specified by:
    
    detach in interface IRBTNode<E>
  - isAttached
```
public boolean isAttached()
```
    Specified by:
    
    isAttached in interface IRBTNode<E>
  - compareTo
```
public int compareTo(IRBTComparableNode<E> node)
              throws RBTException
```
    Specified by:
    
    compareTo in interface IRBTComparableNode<E>
    
    Throws:
    
    RBTException
  - compareTo
```
public int compareTo(E element)
              throws RBTException
```
    Specified by:
    
    compareTo in interface IRBTComparableNode<E>
    
    Throws:
    
    RBTException
  - accept
```
public void accept(IRBTVisitor<E> visitor)
            throws RBTException
```
    Description copied from interface: IRBTVisitable
    
    accept red black tree visitor
    
    Specified by:
    
    accept in interface IRBTVisitable<E>
    
    Parameters:
    visitor - the red black tree visitor
    
    Throws:
    
    RBTException - node access error
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RBTNode<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

element

comparator

Constructor Detail

RBTNode

RBTNode

RBTNode

RBTNode

Method Detail

newInstance

newInstance

newInstance

newInstance

isColorSetted

isBlack

setBlack

isRed

setRed

getParent

setParent

getLeft

setLeft

getRight

setRight

getElement

setElement

isSentinel

getColor

setColor

getNumberOfChild

setNumberOfChild

setIndex

getIndex

decrementNumberOfChild

incrementNumberOfChild

detach

isAttached

compareTo

compareTo

accept

equals

hashCode

toString