public class SearchCursorImpl extends AbstractCursor<Response> implements SearchCursor
Constructor and Description |
---|
SearchCursorImpl(SearchFuture future,
long timeout,
TimeUnit timeUnit)
Instantiates a new search cursor.
|
Modifier and Type | Method and Description |
---|---|
void |
after(Response element)
This operation is not supported in SearchCursor.
|
void |
afterLast()
This operation is not supported in SearchCursor.
|
boolean |
available()
Determines whether or not a call to get() will succeed.
|
void |
before(Response element)
This operation is not supported in SearchCursor.
|
void |
beforeFirst()
This operation is not supported in SearchCursor.
|
void |
close() |
void |
close(Exception cause)
Closes this Cursor and frees any resources it my have allocated.
|
boolean |
first()
This operation is not supported in SearchCursor.
|
Response |
get()
Gets the object at the current position.
|
Entry |
getEntry() |
IntermediateResponse |
getIntermediate() |
Referral |
getReferral() |
SearchResultDone |
getSearchResultDone()
gives the SearchResultDone message received at the end of search results
|
boolean |
isDone() |
boolean |
isEntry() |
boolean |
isIntermediate() |
boolean |
isReferral() |
boolean |
last()
This operation is not supported in SearchCursor.
|
boolean |
next()
Advances this Cursor to the next position.
|
boolean |
previous()
This operation is not supported in SearchCursor.
|
checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor, toString
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, setClosureMonitor, toString
forEach, iterator, spliterator
public SearchCursorImpl(SearchFuture future, long timeout, TimeUnit timeUnit)
future
- the futuretimeout
- the timeouttimeUnit
- the time unitpublic boolean next() throws LdapException, CursorException
next
in interface Cursor<Response>
LdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor to
the next position, or if this Cursor is closedpublic Response get() throws InvalidCursorPositionException
get
in interface Cursor<Response>
InvalidCursorPositionException
public SearchResultDone getSearchResultDone()
getSearchResultDone
in interface SearchCursor
public boolean available()
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class AbstractCursor<Response>
IOException
public void close(Exception cause) throws IOException
close
in interface Cursor<Response>
close
in class AbstractCursor<Response>
cause
- exception thrown when this Cursor is accessed after closeIOException
- If we can't close the Cursorpublic void after(Response element) throws LdapException, CursorException
after
in interface Cursor<Response>
element
- the element to be positioned afterLdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor after
the given element, or if this Cursor is closedpublic void afterLast() throws LdapException, CursorException
afterLast
in interface Cursor<Response>
LdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor after
the last position, or if this Cursor is closedpublic void before(Response element) throws LdapException, CursorException
before
in interface Cursor<Response>
element
- the element to be positioned beforeLdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor before
the given element, or if this Cursor is closedpublic void beforeFirst() throws LdapException, CursorException
beforeFirst
in interface Cursor<Response>
LdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor before
the first position, or if this Cursor is closedpublic boolean first() throws LdapException, CursorException
first
in interface Cursor<Response>
LdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor to
the first position, or if this Cursor is closedpublic boolean last() throws LdapException, CursorException
last
in interface Cursor<Response>
LdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor to
the last position, or if this Cursor is closedpublic boolean previous() throws LdapException, CursorException
previous
in interface Cursor<Response>
LdapException
- if we have get any LDAP exception while operating
the cursorCursorException
- if there are problems advancing to this Cursor to
the previous position, or if this Cursor is closedpublic boolean isDone()
isDone
in interface SearchCursor
public boolean isReferral()
isReferral
in interface SearchCursor
public Referral getReferral() throws LdapException
getReferral
in interface SearchCursor
LdapException
- If thepublic boolean isEntry()
isEntry
in interface SearchCursor
public Entry getEntry() throws LdapException
getEntry
in interface SearchCursor
LdapException
- If thepublic boolean isIntermediate()
isIntermediate
in interface SearchCursor
public IntermediateResponse getIntermediate() throws LdapException
getIntermediate
in interface SearchCursor
LdapException
- If theCopyright © 2003–2018 The Apache Software Foundation. All rights reserved.