org.ldaptive.provider

Interface SearchIterator

All Known Implementing Classes:

ApacheLdapConnection.ApacheLdapSearchIterator, JLdapConnection.JLdapSearchIterator, JndiConnection.JndiSearchIterator, OpenDJConnection.OpenDJSearchIterator, UnboundIDConnection.UnboundIDSearchIterator

public interface SearchIterator

Search results iterator.

Method Summary

Modifier and Type	Method and Description
void	close() Close any resources associated with this iterator.
Response<Void>	getResponse() Returns the response data associated with this search or null if this iterator has more ldap entries to return.
boolean	hasNext() Returns true if the iteration has more elements.
SearchItem	next() Returns the next element in the iteration.

Method Detail

hasNext

boolean hasNext()
         throws LdapException

Returns true if the iteration has more elements.

Returns:

true if the iterator has more elements

Throws:

LdapException - if an error occurs

next

SearchItem next()
         throws LdapException

Returns the next element in the iteration.

Returns:

the next element in the iteration

Throws:

LdapException - if an error occurs

getResponse

Response<Void> getResponse()

Returns the response data associated with this search or null if this iterator has more ldap entries to return.

Returns:

response data

close

void close()
    throws LdapException

Close any resources associated with this iterator.

Throws:

LdapException - if an error occurs