public class EntryCursorImpl extends AbstractCursor<Entry> implements EntryCursor
Constructor and Description |
---|
EntryCursorImpl(SearchCursor searchCursor)
Instantiates a new search cursor, embedding a SearchCursor.
|
Modifier and Type | Method and Description |
---|---|
void |
after(Entry 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(Entry 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.
|
Entry |
get()
Gets the object at the current position.
|
int |
getMessageId() |
SearchResultDone |
getSearchResultDone()
gives the SearchResultDone message received at the end of search results
|
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 EntryCursorImpl(SearchCursor searchCursor)
searchCursor
- the embedded SearchResponse cursorpublic boolean next() throws LdapException, CursorException
next
in interface Cursor<Entry>
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 Entry get() throws CursorException
get
in interface Cursor<Entry>
CursorException
- if the object at this Cursor's current position
cannot be retrieved, or if this Cursor is closedpublic SearchResultDone getSearchResultDone()
getSearchResultDone
in interface EntryCursor
public boolean available()
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class AbstractCursor<Entry>
IOException
public void close(Exception cause) throws IOException
close
in interface Cursor<Entry>
close
in class AbstractCursor<Entry>
cause
- exception thrown when this Cursor is accessed after closeIOException
- If we can't close the Cursorpublic void after(Entry element) throws LdapException, CursorException
after
in interface Cursor<Entry>
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<Entry>
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(Entry element) throws LdapException, CursorException
before
in interface Cursor<Entry>
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<Entry>
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<Entry>
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<Entry>
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<Entry>
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 int getMessageId()
getMessageId
in interface EntryCursor
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.