org.apache.directory.server.core.partition.impl.btree.jdbm

Class KeyBTreeCursor<E>

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<E>

org.apache.directory.server.core.partition.impl.btree.jdbm.KeyBTreeCursor<E>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<E>, org.apache.directory.api.ldap.model.cursor.Cursor<E>

public class KeyBTreeCursor<E>
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<E>

Cursor over the keys of a JDBM BTree. Obviously does not return duplicate keys since JDBM does not natively support multiple values for the same key.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
KeyBTreeCursor(jdbm.btree.BTree btree, Comparator<E> comparator) Creates a Cursor over the keys of a JDBM BTree.

Method Summary

Modifier and Type	Method and Description
void	after(E element)
void	afterLast()
boolean	available()
void	before(E element)
void	beforeFirst()
void	close()
void	close(Exception cause)
boolean	first()
E	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

KeyBTreeCursor

public KeyBTreeCursor(jdbm.btree.BTree btree,
                      Comparator<E> comparator)

Creates a Cursor over the keys of a JDBM BTree.

Parameters:

btree - the JDBM BTree to build a Cursor over

comparator - the Comparator used to determine key ordering

Method Detail

available

public boolean available()

before

public void before(E 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

after

public void after(E 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 E 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<E>

Throws:

IOException

close

public void close(Exception cause)
           throws IOException

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<E>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<E>

Throws:

IOException