E
- The element on which this cursor will iteratepublic class SetCursor<E> extends AbstractCursor<E>
Set
. Optionally, the
Cursor may be limited to a specific range within the list.Constructor and Description |
---|
SetCursor()
Creates a new SetCursor without any elements.
|
SetCursor(Comparator<E> comparator)
Creates a new SetCursor without any elements.
|
SetCursor(Comparator<E> comparator,
Set<E> set)
Creates a new SetCursor.
|
SetCursor(Set<E> set)
Creates a new SetCursor
As with all Cursors, this SetCursor requires a successful return from
advance operations (next() or previous()) to properly return values
using the get() operation.
|
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() |
void |
close(Exception cause)
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 |
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.
|
String |
toString() |
String |
toString(String tabs)
Pretty-print a cursor and its wrapped cursor.
|
checkNotClosed, isClosed, iterator, setClosureMonitor
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public SetCursor(Comparator<E> comparator, Set<E> set)
comparator
- an optional comparator to use for orderingset
- the Set this StCursor operates onpublic SetCursor(Set<E> set)
set
- the Set this SetCursor operates onpublic SetCursor()
public SetCursor(Comparator<E> comparator)
comparator
- The comparator to use for the <E> elementspublic boolean available()
public void before(E element) throws LdapException, CursorException
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 after(E element) throws LdapException, CursorException
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 beforeFirst() throws LdapException, CursorException
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 void afterLast() throws LdapException, CursorException
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 boolean first() 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 first position, or if this Cursor is closedpublic boolean last() 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 last position, or if this Cursor is closedpublic boolean isFirst()
public boolean isLast()
public boolean isAfterLast()
isAfterLast
in interface Cursor<E>
isAfterLast
in class AbstractCursor<E>
public boolean isBeforeFirst()
isBeforeFirst
in interface Cursor<E>
isBeforeFirst
in class AbstractCursor<E>
public boolean previous() 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 previous position, or if this Cursor is closedpublic 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 closedpublic E get() throws CursorException
CursorException
- if the object at this Cursor's current position
cannot be retrieved, or if this Cursor is closedpublic void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class AbstractCursor<E>
IOException
public void close(Exception cause) throws IOException
close
in interface Cursor<E>
close
in class AbstractCursor<E>
cause
- exception thrown when this Cursor is accessed after closeIOException
- If we can't close the Cursorpublic String toString(String tabs)
AbstractCursor
toString
in interface Cursor<E>
toString
in class AbstractCursor<E>
tabs
- The spaces to add at each levelObject.toString()
public String toString()
toString
in class Object
Object.toString()
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.