E
- The type of element on which this cursor will iteratepublic interface Cursor<E> extends Iterable<E>
Modifier and Type | Method and Description |
---|---|
void |
after(E element)
Prepares this Cursor, so a subsequent call to Cursor#previous() with a
true return value, will have positioned the Cursor on a dataSet element
equal to or less than the element argument but not greater.
|
void |
afterLast()
Positions this Cursor after the last element.
|
boolean |
available()
Determines whether or not a call to get() will succeed.
|
void |
before(E element)
Prepares this Cursor, so a subsequent call to Cursor#next() with a
true return value, will have positioned the Cursor on a dataSet
element equal to or less than the element argument but not greater.
|
void |
beforeFirst()
Positions this Cursor before the first element.
|
void |
close()
Closes this Cursor and frees any resources it my have allocated.
|
void |
close(Exception reason)
Closes this Cursor and frees any resources it my have allocated.
|
boolean |
first()
Positions this Cursor at the first element.
|
E |
get()
Gets the object at the current position.
|
boolean |
isAfterLast()
Is this Cursor positioned after the last element.
|
boolean |
isBeforeFirst()
Is this Cursor positioned before the first element.
|
boolean |
isClosed()
Checks if this Cursor is closed.
|
boolean |
isFirst()
Is this Cursor positioned at the first element.
|
boolean |
isLast()
Is this Cursor positioned at the last element.
|
boolean |
last()
Positions this Cursor at the last element.
|
boolean |
next()
Advances this Cursor to the next position.
|
boolean |
previous()
Advances this Cursor to the previous position.
|
void |
setClosureMonitor(ClosureMonitor monitor)
Sets a non-null closure monitor to associate with this Cursor.
|
String |
toString(String tabs)
Pretty-print a cursor and its wrapped cursor.
|
boolean available()
void before(E element) throws LdapException, CursorException
element
- the element to be positioned beforeException
- with problems accessing the underlying btreeLdapException
CursorException
void after(E element) throws LdapException, CursorException
element
- the element to be positioned afterException
- if there are problems positioning this cursor or if
this Cursor is closedLdapException
CursorException
void beforeFirst() throws LdapException, CursorException
Exception
- if there are problems positioning this cursor or if
this Cursor is closedLdapException
CursorException
void afterLast() throws LdapException, CursorException
Exception
- if there are problems positioning this Cursor or if
this Cursor is closedLdapException
CursorException
boolean first() throws LdapException, CursorException
Exception
- if there are problems positioning this Cursor or if
this Cursor is closedLdapException
CursorException
boolean isFirst()
Exception
- if there are problems querying the position of this Cursor
or if this Cursor is closedboolean isBeforeFirst()
Exception
- if there are problems querying the position of this Cursor
or if this Cursor is closedboolean last() throws LdapException, CursorException
Exception
- if there are problems positioning this Cursor or if
this Cursor is closedLdapException
CursorException
boolean isLast()
Exception
- if there are problems querying the position of this Cursor
or if this Cursor is closedboolean isAfterLast()
Exception
- if there are problems querying the position of this Cursor
or if this Cursor is closedboolean isClosed()
boolean previous() throws LdapException, CursorException
Exception
- if there are problems advancing to the next positionLdapException
CursorException
boolean next() throws LdapException, CursorException
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 closedIOException
- If we have had any IO ExceptionE get() throws CursorException
CursorException
- if the object at this Cursor's current position
cannot be retrieved, or if this Cursor is closedIOException
- If we have had any IO Exceptionvoid close()
void close(Exception reason)
reason
- exception thrown when this Cursor is accessed after closevoid setClosureMonitor(ClosureMonitor monitor)
monitor
- the monitor to use for detecting Cursor close eventsCopyright © 2003–2015 The Apache Software Foundation. All rights reserved.