Package org.apache.commons.collections4.bidimap

Class TreeBidiMap.Node<K extends Comparable<K>,V extends Comparable<V>>

java.lang.Object

org.apache.commons.collections4.bidimap.TreeBidiMap.Node<K,V>

All Implemented Interfaces:

Map.Entry<K,V>, KeyValue<K,V>

Enclosing class:

TreeBidiMap<K extends Comparable<K>,V extends Comparable<V>>

static class TreeBidiMap.Node<K extends Comparable<K>,V extends Comparable<V>>
extends Object
implements Map.Entry<K,V>, KeyValue<K,V>

A node used to store the data.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean[]	blackColor
private boolean	calculatedHashCode
private int	hashCodeValue
private final K	key
private final TreeBidiMap.Node<K,V>[]	leftNode
private final TreeBidiMap.Node<K,V>[]	parentNode
private final TreeBidiMap.Node<K,V>[]	rightNode
private final V	value

Constructor Summary

Constructors

Constructor	Description
Node(K key, V value)	Makes a new cell with given key and value, and with null links, and black (true) colors.

Method Summary

Modifier and Type	Method	Description
private void	copyColor(TreeBidiMap.Node<K,V> node, TreeBidiMap.DataElement dataElement)	Makes this node the same color as another.
boolean	equals(Object obj)	Compares the specified object with this entry for equality.
private Object	getData(TreeBidiMap.DataElement dataElement)
K	getKey()	Gets the key.
private TreeBidiMap.Node<K,V>	getLeft(TreeBidiMap.DataElement dataElement)
private TreeBidiMap.Node<K,V>	getParent(TreeBidiMap.DataElement dataElement)	Gets the parent node.
private TreeBidiMap.Node<K,V>	getRight(TreeBidiMap.DataElement dataElement)
V	getValue()	Gets the value.
int	hashCode()
private boolean	isBlack(TreeBidiMap.DataElement dataElement)	Is this node black?
private boolean	isLeftChild(TreeBidiMap.DataElement dataElement)
private boolean	isRed(TreeBidiMap.DataElement dataElement)	Is this node red?
private boolean	isRightChild(TreeBidiMap.DataElement dataElement)
private void	setBlack(TreeBidiMap.DataElement dataElement)	Makes this node black.
private void	setLeft(TreeBidiMap.Node<K,V> node, TreeBidiMap.DataElement dataElement)
private void	setParent(TreeBidiMap.Node<K,V> node, TreeBidiMap.DataElement dataElement)	Sets this node's parent node.
private void	setRed(TreeBidiMap.DataElement dataElement)	Makes this node red.
private void	setRight(TreeBidiMap.Node<K,V> node, TreeBidiMap.DataElement dataElement)
V	setValue(V ignored)	Optional operation that is not permitted in this implementation.
private void	swapColors(TreeBidiMap.Node<K,V> node, TreeBidiMap.DataElement dataElement)	Exchanges colors with another node.

Methods inherited from class java.lang.Object

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

Field Details

key

private final K extends Comparable<K> key

value

private final V extends Comparable<V> value

leftNode

private final TreeBidiMap.Node<K extends Comparable<K>,V extends Comparable<V>>[] leftNode

rightNode

private final TreeBidiMap.Node<K extends Comparable<K>,V extends Comparable<V>>[] rightNode

parentNode

private final TreeBidiMap.Node<K extends Comparable<K>,V extends Comparable<V>>[] parentNode

blackColor

private final boolean[] blackColor

hashCodeValue

private int hashCodeValue

calculatedHashCode

private boolean calculatedHashCode

Constructor Details

Node

Node(K key,
 V value)

Makes a new cell with given key and value, and with null links, and black (true) colors.

Parameters:

key - the key of this node

value - the value of this node

Method Details

copyColor

private void copyColor(TreeBidiMap.Node<K,V> node,
 TreeBidiMap.DataElement dataElement)

Makes this node the same color as another.

Parameters:

node - the node whose color we're adopting

dataElement - either the key or the value.

equals

public boolean equals(Object obj)

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping.

Specified by:

equals in interface Map.Entry<K extends Comparable<K>,V extends Comparable<V>>

Overrides:

equals in class Object

Parameters:

obj - the object to be compared for equality with this entry.

Returns:

true if the specified object is equal to this entry.

getData

private Object getData(TreeBidiMap.DataElement dataElement)

getKey

public K getKey()

Gets the key.

Specified by:

getKey in interface KeyValue<K extends Comparable<K>,V extends Comparable<V>>

Specified by:

getKey in interface Map.Entry<K extends Comparable<K>,V extends Comparable<V>>

Returns:

the key corresponding to this entry.

getLeft

private TreeBidiMap.Node<K,V> getLeft(TreeBidiMap.DataElement dataElement)

getParent

private TreeBidiMap.Node<K,V> getParent(TreeBidiMap.DataElement dataElement)

Gets the parent node.

Parameters:

dataElement - either the key or the value.

Returns:

the parent node, may be null

getRight

private TreeBidiMap.Node<K,V> getRight(TreeBidiMap.DataElement dataElement)

getValue

public V getValue()

Gets the value.

Specified by:

getValue in interface KeyValue<K extends Comparable<K>,V extends Comparable<V>>

Specified by:

getValue in interface Map.Entry<K extends Comparable<K>,V extends Comparable<V>>

Returns:

the value corresponding to this entry.

hashCode

public int hashCode()

Specified by:

hashCode in interface Map.Entry<K extends Comparable<K>,V extends Comparable<V>>

Overrides:

hashCode in class Object

Returns:

the hash code value for this map entry.

isBlack

private boolean isBlack(TreeBidiMap.DataElement dataElement)

Is this node black?

Parameters:

dataElement - either the key or the value.

Returns:

true if black (which is represented as a true boolean)

isLeftChild

private boolean isLeftChild(TreeBidiMap.DataElement dataElement)

isRed

private boolean isRed(TreeBidiMap.DataElement dataElement)

Is this node red?

Parameters:

dataElement - either the key or the value.

Returns:

true if non-black

isRightChild

private boolean isRightChild(TreeBidiMap.DataElement dataElement)

setBlack

private void setBlack(TreeBidiMap.DataElement dataElement)

Makes this node black.

Parameters:

dataElement - either the key or the value.

setLeft

private void setLeft(TreeBidiMap.Node<K,V> node,
 TreeBidiMap.DataElement dataElement)

setParent

private void setParent(TreeBidiMap.Node<K,V> node,
 TreeBidiMap.DataElement dataElement)

Sets this node's parent node.

Parameters:

node - the new parent node

dataElement - either the key or the value.

setRed

private void setRed(TreeBidiMap.DataElement dataElement)

Makes this node red.

Parameters:

dataElement - either the key or the value.

setRight

private void setRight(TreeBidiMap.Node<K,V> node,
 TreeBidiMap.DataElement dataElement)

setValue

public V setValue(V ignored)
           throws UnsupportedOperationException

Optional operation that is not permitted in this implementation.

Specified by:

setValue in interface Map.Entry<K extends Comparable<K>,V extends Comparable<V>>

Parameters:

ignored - this parameter is ignored.

Returns:

does not return

Throws:

UnsupportedOperationException - always

swapColors

private void swapColors(TreeBidiMap.Node<K,V> node,
 TreeBidiMap.DataElement dataElement)

Exchanges colors with another node.

Parameters:

node - the node to swap with

dataElement - either the key or the value.