org.apache.directory.mavibot.btree

Class Tuple<K,V>

java.lang.Object

org.apache.directory.mavibot.btree.Tuple<K,V>

Type Parameters:

K - The type for the Key

V - The type for the stored value

All Implemented Interfaces:

java.lang.Comparable<Tuple<K,V>>

Direct Known Subclasses:

Modification, NameRevision, RevisionName

public class Tuple<K,V>
extends java.lang.Object
implements java.lang.Comparable<Tuple<K,V>>

The Tuple class is used when we browse a btree, it will contain the results fetched from the btree.

Field Summary

Fields

Modifier and Type	Field and Description
protected K	key The key
protected java.util.Comparator<K>	keyComparator The key comparator
protected V	value The value

Constructor Summary

Constructors

Constructor and Description
Tuple() Creates a Tuple with no content
Tuple(K key, V value) Creates a Tuple containing a key and its associated value.
Tuple(K key, V value, java.util.Comparator<K> keyComparator) Creates a Tuple containing a key and its associated value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Tuple<K,V> t)
boolean	equals(java.lang.Object obj)
K	getKey()
java.util.Comparator<K>	getKeyComparator()
V	getValue()
int	hashCode()
void	setKey(K key)
void	setKeyComparator(java.util.Comparator<K> keyComparator)
void	setValue(V value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

key

protected K key

The key

value

protected V value

The value

keyComparator

protected java.util.Comparator<K> keyComparator

The key comparator

Constructor Detail

Tuple

public Tuple()

Creates a Tuple with no content

Tuple

public Tuple(K key,
             V value)

Creates a Tuple containing a key and its associated value.

Parameters:

key - The key

value - The associated value

Tuple

public Tuple(K key,
             V value,
             java.util.Comparator<K> keyComparator)

Creates a Tuple containing a key and its associated value.

Parameters:

key - The key

value - The associated value

Method Detail

getKey

public K getKey()

Returns:

the key

setKey

public void setKey(K key)

Parameters:

key - the key to set

getValue

public V getValue()

Returns:

the value

setValue

public void setValue(V value)

Parameters:

value - the value to set

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object#equals()

compareTo

public int compareTo(Tuple<K,V> t)

Specified by:

compareTo in interface java.lang.Comparable<Tuple<K,V>>

See Also:

Comparable.compareTo(java.lang.Object)

getKeyComparator

public java.util.Comparator<K> getKeyComparator()

Returns:

the keyComparator

setKeyComparator

public void setKeyComparator(java.util.Comparator<K> keyComparator)

Parameters:

keyComparator - the keyComparator to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()