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

Class EntryCursorAdaptor

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

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

All Implemented Interfaces:

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

public class EntryCursorAdaptor
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

Adapts index cursors to return just Entry objects.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
EntryCursorAdaptor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, AbstractBTreePartition db, PartitionSearchResult searchResult)

Method Summary

Modifier and Type	Method and Description
void	after(org.apache.directory.api.ldap.model.entry.Entry element)
void	afterLast()
boolean	available()
void	before(org.apache.directory.api.ldap.model.entry.Entry element)
void	beforeFirst()
void	close() }
void	close(Exception cause)
boolean	first()
org.apache.directory.api.ldap.model.entry.Entry	get()
boolean	isClosed()
boolean	last()
boolean	next()
boolean	previous()
void	setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)
String	toString()
String	toString(String tabs)

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

checkNotClosed, isAfterLast, isBeforeFirst, isFirst, isLast, iterator

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

EntryCursorAdaptor

public EntryCursorAdaptor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                          AbstractBTreePartition db,
                          PartitionSearchResult searchResult)

Method Detail

after

public void after(org.apache.directory.api.ldap.model.entry.Entry 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

available

public boolean available()

before

public void before(org.apache.directory.api.ldap.model.entry.Entry 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

setClosureMonitor

public final void setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

Specified by:

setClosureMonitor in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

setClosureMonitor in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

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.entry.Entry>

Throws:

IOException

close

public void close(Exception cause)
           throws IOException

Specified by:

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

Overrides:

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

Throws:

IOException

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.entry.Entry get()
                                                    throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isClosed in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

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

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.entry.Entry>

Overrides:

toString in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()