org.apache.directory.server.xdbm

Class AbstractIndexCursor<K,E,ID>

java.lang.Object

org.apache.directory.server.xdbm.AbstractIndexCursor<K,E,ID>

All Implemented Interfaces:

Iterable<IndexEntry<K,E,ID>>, IndexCursor<K,E,ID>, org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<K,E,ID>>

Direct Known Subclasses:

AllEntriesCursor, AndCursor, ApproximateCursor, EmptyIndexCursor, EqualityCursor, GreaterEqCursor, LessEqCursor, NotCursor, OneLevelScopeCursor, OrCursor, PresenceCursor, SingletonIndexCursor, SubstringCursor, SubtreeScopeCursor

public abstract class AbstractIndexCursor<K,E,ID>
extends Object
implements IndexCursor<K,E,ID>

An abstract TupleCursor.

Version:

$Rev$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
AbstractIndexCursor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkNotClosed(String operation)
void	close()
void	close(Exception cause)
boolean	isClosed()
Iterator<IndexEntry<K,E,ID>>	iterator()
void	setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.server.xdbm.IndexCursor

afterValue, beforeValue

Methods inherited from interface org.apache.directory.shared.ldap.cursor.Cursor

after, afterLast, available, before, beforeFirst, first, get, isElementReused, last, next, previous

Constructor Detail

AbstractIndexCursor

public AbstractIndexCursor()

Method Detail

setClosureMonitor

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

Specified by:

setClosureMonitor in interface org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<K,E,ID>>

checkNotClosed

protected final void checkNotClosed(String operation)
                             throws Exception

Throws:

Exception

isClosed

public final boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<K,E,ID>>

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<K,E,ID>>

Throws:

Exception

close

public void close(Exception cause)
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<K,E,ID>>

Throws:

Exception

iterator

public Iterator<IndexEntry<K,E,ID>> iterator()

Specified by:

iterator in interface Iterable<IndexEntry<K,E,ID>>