org.apache.directory.shared.ldap.cursor

Class AbstractCursor<E>

java.lang.Object

org.apache.directory.shared.ldap.cursor.AbstractCursor<E>

All Implemented Interfaces:

Iterable<E>, Cursor<E>

Direct Known Subclasses:

EmptyCursor, ListCursor, SingletonCursor

public abstract class AbstractCursor<E>
extends Object
implements Cursor<E>

Simple class that contains often used Cursor code.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
AbstractCursor()

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed(String operation) Check that the cursor is not closed.
void	close() Closes this Cursor and frees any resources it my have allocated.
void	close(Exception cause) Closes this Cursor and frees any resources it my have allocated.
boolean	isClosed() Checks if this Cursor is closed.
Iterator<E>	iterator()
void	setClosureMonitor(ClosureMonitor monitor) Sets a non-null closure monitor to associate with this Cursor.

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.shared.ldap.cursor.Cursor

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractCursor

public AbstractCursor()

Method Detail

setClosureMonitor

public final void setClosureMonitor(ClosureMonitor monitor)

Sets a non-null closure monitor to associate with this Cursor.

Specified by:

setClosureMonitor in interface Cursor<E>

Parameters:

monitor - the monitor to use for detecting Cursor close events

checkNotClosed

protected final void checkNotClosed(String operation)
                             throws Exception

Check that the cursor is not closed.

Parameters:

operation -

Throws:

Exception

isClosed

public final boolean isClosed()

Checks if this Cursor is closed. Calls to this operation should not fail with exceptions if and only if the cursor is in the closed state.

Specified by:

isClosed in interface Cursor<E>

Returns:

true if this Cursor is closed, false otherwise

close

public void close(Exception cause)
           throws Exception

Closes this Cursor and frees any resources it my have allocated. Repeated calls to this method after this Cursor has already been called should not fail with exceptions. The reason argument is the Exception instance thrown instead of the standard CursorClosedException.

Specified by:

close in interface Cursor<E>

Parameters:

cause - exception thrown when this Cursor is accessed after close

Throws:

Exception - if for some reason this Cursor could not be closed

close

public void close()
           throws Exception

Closes this Cursor and frees any resources it my have allocated. Repeated calls to this method after this Cursor has already been called should not fail with exceptions.

Specified by:

close in interface Cursor<E>

Throws:

Exception - if for some reason this Cursor could not be closed

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>