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

Interface EntryCursor

All Superinterfaces:

AutoCloseable, Closeable, Cursor<Entry>, Iterable<Entry>

All Known Implementing Classes:

EntryCursorImpl

public interface EntryCursor
extends Cursor<Entry>

An extension of Cursor which returns only Entry objects and includes the retrieval of the SearchResultDone.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method	Description
int	getMessageId()
SearchResultDone	getSearchResultDone()	gives the SearchResultDone message received at the end of search results

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.directory.api.ldap.model.cursor.Cursor

after, afterLast, available, before, beforeFirst, close, first, get, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, last, next, previous, setClosureMonitor, toString

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getSearchResultDone

SearchResultDone getSearchResultDone()

gives the SearchResultDone message received at the end of search results

Returns:

the SearchResultDone message, null if the search operation fails for any reason

getMessageId

int getMessageId()

Returns:

the underlying message ID