org.apache.directory.ldap.client.api

Class SearchCursor

java.lang.Object

org.apache.directory.shared.ldap.cursor.AbstractCursor

org.apache.directory.ldap.client.api.SearchCursor

All Implemented Interfaces:

Iterable, org.apache.directory.shared.ldap.cursor.Cursor

public class SearchCursor
extends org.apache.directory.shared.ldap.cursor.AbstractCursor

An implementation of Cursor based on the underlying SearchFuture instance. Note: This is a forward only cursor hence the only valid operations are next(), get() and close()

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SearchCursor(SearchFuture future, long timeout, TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
void	after(Object element)
void	afterLast()
boolean	available()
void	before(Object element)
void	beforeFirst()
void	close()
void	close(Exception cause)
boolean	first()
SearchResponse	get()
boolean	isElementReused()
boolean	last()
boolean	next()
boolean	previous()

Methods inherited from class org.apache.directory.shared.ldap.cursor.AbstractCursor

checkNotClosed, isClosed, iterator, setClosureMonitor

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

SearchCursor

public SearchCursor(SearchFuture future,
                    long timeout,
                    TimeUnit timeUnit)

Method Detail

next

public boolean next()
             throws Exception

Throws:

Exception

get

public SearchResponse get()
                   throws Exception

Throws:

Exception

isElementReused

public boolean isElementReused()

available

public boolean available()

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.cursor.Cursor

Overrides:

close in class org.apache.directory.shared.ldap.cursor.AbstractCursor

Throws:

Exception

close

public void close(Exception cause)
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.cursor.Cursor

Overrides:

close in class org.apache.directory.shared.ldap.cursor.AbstractCursor

Throws:

Exception

after

public void after(Object element)
           throws Exception

Throws:

Exception

afterLast

public void afterLast()
               throws Exception

Throws:

Exception

before

public void before(Object element)
            throws Exception

Throws:

Exception

beforeFirst

public void beforeFirst()
                 throws Exception

Throws:

Exception

first

public boolean first()
              throws Exception

Throws:

Exception

last

public boolean last()
             throws Exception

Throws:

Exception

previous

public boolean previous()
                 throws Exception

Throws:

Exception