org.apache.directory.server.xdbm.impl.avl

Class AvlTableDupsCursor<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.impl.avl.AvlTableDupsCursor<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 AvlTableDupsCursor<K,V>
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

A Cursor which walks and advance over AvlTables that may contain duplicate keys with values stored in an AvlTree. All duplicate keys are traversed returning the key and the value in a Tuple.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
AvlTableDupsCursor(AvlTable<K,V> table) Creates a new instance of AvlTableDupsCursor.

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)
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()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AvlTableDupsCursor

public AvlTableDupsCursor(AvlTable<K,V> table)

Creates a new instance of AvlTableDupsCursor.

Parameters:

table - the AvlTable to build a Cursor on.

Method Detail

available

public boolean available()

beforeKey

public void beforeKey(K key)
               throws Exception

Throws:

Exception

beforeValue

public void beforeValue(K key,
                        V value)
                 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

afterKey

public void afterKey(K key)
              throws Exception

Throws:

Exception

afterValue

public void afterValue(K key,
                       V value)
                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

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

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

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

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

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

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

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

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

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

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