org.apache.directory.ldap.client.api
Class EntryCursorImpl

java.lang.Object
  org.apache.directory.shared.ldap.model.cursor.AbstractCursor<Entry>
      org.apache.directory.ldap.client.api.EntryCursorImpl

All Implemented Interfaces:

Iterable<Entry>, Cursor<Entry>, EntryCursor

public class EntryCursorImpl
extends AbstractCursor<Entry>
implements EntryCursor

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()

Author:

Apache Directory Project

Constructor Summary

EntryCursorImpl(SearchCursor searchCursor)
Instantiates a new search cursor, embedding a SearchCursor.

Method Summary

void	after(Entry element) This operation is not supported in SearchCursor.
void	afterLast() This operation is not supported in SearchCursor.
boolean	available()
void	before(Entry element) This operation is not supported in SearchCursor.
void	beforeFirst() This operation is not supported in SearchCursor.
void	close()
void	close(Exception cause)
boolean	first() This operation is not supported in SearchCursor.
Entry	get()
int	getMessageId()
SearchResultDone	getSearchResultDone()
boolean	last() This operation is not supported in SearchCursor.
boolean	next()
boolean	previous() This operation is not supported in SearchCursor.

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

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor

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.model.cursor.Cursor

isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, setClosureMonitor

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

EntryCursorImpl

public EntryCursorImpl(SearchCursor searchCursor)

Instantiates a new search cursor, embedding a SearchCursor.

Parameters:

searchCursor - the embedded SearchResponse cursor

Method Detail

next

public boolean next()
             throws Exception

Specified by:

next in interface Cursor<Entry>

Throws:

Exception

get

public Entry get()
          throws Exception

Specified by:

get in interface Cursor<Entry>

Throws:

Exception

getSearchResultDone

public SearchResultDone getSearchResultDone()

Specified by:

getSearchResultDone in interface EntryCursor

available

public boolean available()

Specified by:

available in interface Cursor<Entry>

close

public void close()
           throws Exception

Specified by:

close in interface Cursor<Entry>

Overrides:

close in class AbstractCursor<Entry>

Throws:

Exception

close

public void close(Exception cause)
           throws Exception

Specified by:

close in interface Cursor<Entry>

Overrides:

close in class AbstractCursor<Entry>

Throws:

Exception

after

public void after(Entry element)
           throws Exception

This operation is not supported in SearchCursor.

Specified by:

after in interface Cursor<Entry>

Throws:

Exception

afterLast

public void afterLast()
               throws Exception

This operation is not supported in SearchCursor.

Specified by:

afterLast in interface Cursor<Entry>

Throws:

Exception

before

public void before(Entry element)
            throws Exception

This operation is not supported in SearchCursor.

Specified by:

before in interface Cursor<Entry>

Throws:

Exception

beforeFirst

public void beforeFirst()
                 throws Exception

This operation is not supported in SearchCursor.

Specified by:

beforeFirst in interface Cursor<Entry>

Throws:

Exception

first

public boolean first()
              throws Exception

This operation is not supported in SearchCursor.

Specified by:

first in interface Cursor<Entry>

Throws:

Exception

last

public boolean last()
             throws Exception

This operation is not supported in SearchCursor.

Specified by:

last in interface Cursor<Entry>

Throws:

Exception

previous

public boolean previous()
                 throws Exception

This operation is not supported in SearchCursor.

Specified by:

previous in interface Cursor<Entry>

Throws:

Exception

getMessageId

public int getMessageId()

Specified by:

getMessageId in interface EntryCursor