org.apache.directory.server.xdbm

Class KeyTupleArrayCursor<K,V>

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

org.apache.directory.server.xdbm.KeyTupleArrayCursor<K,V>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

public class KeyTupleArrayCursor<K,V>
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Cursor over a set of values for the same key which are store in an in memory ArrayTree. This Cursor is limited to the same key and it's tuples will always return the same key.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
KeyTupleArrayCursor(ArrayTree<V> arrayTree, K key) Creates a Cursor over the tuples of an ArrayTree.

Method Summary

Modifier and Type	Method and Description
void	after(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
void	afterKey(K key)
void	afterLast()
void	afterValue(K key, V value)
boolean	available()
void	before(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element) Positions this Cursor over the same keys before the value of the supplied element Tuple.
void	beforeFirst()
void	beforeKey(K key)
void	beforeValue(K key, V value)
void	close()
void	close(Exception reason)
boolean	first()
org.apache.directory.api.ldap.model.cursor.Tuple<K,V>	get()
boolean	last()
boolean	next()
boolean	previous()
String	toString()
String	toString(String tabs)

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyTupleArrayCursor

public KeyTupleArrayCursor(ArrayTree<V> arrayTree,
                           K key)

Creates a Cursor over the tuples of an ArrayTree.

Parameters:

arrayTree - the ArrayTree to build a Tuple returning Cursor over

key - the constant key for which values are returned

Method Detail

available

public boolean available()

beforeKey

public void beforeKey(K key)
               throws Exception

Throws:

Exception

afterKey

public void afterKey(K key)
              throws Exception

Throws:

Exception

beforeValue

public void beforeValue(K key,
                        V value)
                 throws Exception

Throws:

Exception

afterValue

public void afterValue(K key,
                       V value)
                throws Exception

Throws:

Exception

before

public void before(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Positions this Cursor over the same keys before the value of the supplied element Tuple. The supplied element Tuple's key is not considered at all.

Parameters:

element - the valueTuple who's value is used to position this Cursor

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there are failures to position the Cursor

org.apache.directory.api.ldap.model.cursor.CursorException - if there are failures to position the Cursor

after

public void after(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

get

public org.apache.directory.api.ldap.model.cursor.Tuple<K,V> get()
                                                          throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.cursor.CursorException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Throws:

IOException

close

public void close(Exception reason)
           throws IOException

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Throws:

IOException

toString

public String toString(String tabs)

Specified by:

toString in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Overrides:

toString in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()