net.sf.joafip.redblacktree.entity

Interface IRBTNode<E>

All Superinterfaces:

IRBTComparableNode<E>, IRBTVisitable<E>

All Known Implementing Classes:

AbstractHeapRBTNode, AbstractHeapRecordableRBTNode, DataRecordIdentifierRBTNode, GarbageReferenceLinkRBTNode, HeapFreeNode, HeapIdNode, RBTNode, RBTSentinel, TreeSupportNode

public interface IRBTNode<E>
extends IRBTComparableNode<E>, IRBTVisitable<E>

Red Black Tree node interface
color definition: RedBlackTree#BLACK and RedBlackTree#RED
Note for implementation: identity must be original object identity in memory, do not redefine Object.equals(Object) and Object.hashCode()

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
void	decrementNumberOfChild()
void	detach() detach the node from the tree
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
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
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

Methods inherited from interface net.sf.joafip.redblacktree.entity.IRBTComparableNode

compareTo, compareTo

Methods inherited from interface net.sf.joafip.redblacktree.service.IRBTVisitable

accept

Method Detail

isColorSetted

boolean isColorSetted()
                      throws RBTException

Returns:

true if node color is set

Throws:

RBTException

isBlack

boolean isBlack()
                throws RBTException

to know if node is black

Returns:

true if node is black

Throws:

RBTException - node access error

setBlack

void setBlack()
              throws RBTException

set node color to black

Throws:

RBTException

isRed

boolean isRed()
              throws RBTException

to know if node is red

Returns:

true if node is red

Throws:

RBTException - node access error

setRed

void setRed()
            throws RBTException

set node color to red

Throws:

RBTException - node access error

getColor

boolean getColor()
                 throws RBTException

get node color
color definition: RedBlackTree#BLACK and RedBlackTree#RED

Returns:

the node color

Throws:

RBTException - node access error

setColor

void setColor(boolean color)
              throws RBTException

set node color
color definition: RedBlackTree#BLACK and RedBlackTree#RED

Parameters:

color - the node color

Throws:

RBTException - node access error

getParent

IRBTNode<E> getParent()
                      throws RBTException

get parent node

Returns:

the parent node, or null if have not ( this is root node )

Throws:

RBTException - node access error

setParent

void setParent(IRBTNode<E> node)
               throws RBTException

set parent node

Parameters:

node - the parent node

Throws:

RBTException - node access error

getLeft

IRBTNode<E> getLeft()
                    throws RBTException

get left child of this node

Returns:

left child of this node

Throws:

RBTException - node access error

setLeft

void setLeft(IRBTNode<E> node)
             throws RBTException

set left child of this node

Parameters:

node - the left child of this node

Throws:

RBTException - node access error

getRight

IRBTNode<E> getRight()
                     throws RBTException

get right child of this node

Returns:

right child of this node

Throws:

RBTException - node access error

setRight

void setRight(IRBTNode<E> node)
              throws RBTException

set right child of this node

Parameters:

node - the right child of this node

Throws:

RBTException - node access error

isSentinel

boolean isSentinel()
                   throws RBTException

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

Returns:

true is this node is a sentinel

Throws:

RBTException - node access error

getNumberOfChild

int getNumberOfChild()
                     throws RBTException

get the number of node in right and left tree node, sentinel excluded

Returns:

the number of children

Throws:

RBTException - node access error

setNumberOfChild

void setNumberOfChild(int numberOfChild)
                      throws RBTException

set the number of node in right and left tree node, sentinel excluded

Parameters:

numberOfChild - the number of children

Throws:

RBTException

setIndex

void setIndex(int index)

getIndex

int getIndex()

setElement

void setElement(E element)
                throws RBTException

set this node element

Parameters:

element - the element to set for this node

Throws:

RBTException

IllegalArgumentException - element is null

getElement

E getElement()
             throws RBTException

get the element of this node

Returns:

the element of this node

Throws:

RBTException

detach

void detach()

detach the node from the tree

isAttached

boolean isAttached()

incrementNumberOfChild

void incrementNumberOfChild()
                            throws RBTException

Throws:

RBTException

decrementNumberOfChild

void decrementNumberOfChild()
                            throws RBTException

Throws:

RBTException