org.apache.directory.mavibot.btree

Interface ValueHolder<V>

Type Parameters:

V - The value type

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

AbstractValueHolder, InMemoryValueHolder, PersistedValueHolder

interface ValueHolder<V>
extends java.lang.Cloneable

A holder to store the Values

Method Summary

Modifier and Type	Method and Description
void	add(V newValue) Add a new value in the ValueHolder
ValueHolder<V>	clone() Create a clone of this instance
boolean	contains(V checkedValue) Tells if a value is contained in this ValueHolder
ValueCursor<V>	getCursor()
boolean	isSubBtree()
V	remove(V removedValue) Remove a value from the ValueHolder
V	replaceValueArray(V newValue) Replaces the single value present in the array.
int	size()

Method Detail

contains

boolean contains(V checkedValue)

Tells if a value is contained in this ValueHolder

Parameters:

checkedValue - The added to check

size

int size()

Returns:

the number of stored values

getCursor

ValueCursor<V> getCursor()

Returns:

a cursor on top of the values

isSubBtree

boolean isSubBtree()

Returns:

true if we store the values in a sub btree

add

void add(V newValue)

Add a new value in the ValueHolder

Parameters:

newValue - The added value

remove

V remove(V removedValue)

Remove a value from the ValueHolder

Parameters:

removedValue - The value to remove

replaceValueArray

V replaceValueArray(V newValue)

Replaces the single value present in the array. This is only applicable for B-Trees that don't support duplicate values.

Parameters:

newValue - the new value

Returns:

the value that was replaced

clone

ValueHolder<V> clone()
              throws java.lang.CloneNotSupportedException

Create a clone of this instance

Returns:

a new instance of a ValueHolder

Throws:

java.lang.CloneNotSupportedException - If we can't clone this instance