|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.core.filtering.CursorList
public class CursorList
An implementation of a Cursor based on a List
of Cursor
s. Optionally, the
Cursor may be limited to a specific range within the list.
This class is modeled based on the implementation of ListCursor
WARN this is only used internally
Constructor Summary | |
---|---|
CursorList(int start,
java.util.List<EntryFilteringCursor> list,
int end,
SearchingOperationContext opContext)
Creates a new ListCursor with lower (inclusive) and upper (exclusive) bounds. |
|
CursorList(java.util.List<EntryFilteringCursor> list,
SearchingOperationContext opContext)
Creates a new ListCursor without specific bounds: the bounds are acquired from the size of the list. |
Method Summary | |
---|---|
boolean |
addEntryFilter(EntryFilter filter)
Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. |
void |
after(ClonedServerEntry element)
|
void |
afterLast()
|
boolean |
available()
|
void |
before(ClonedServerEntry element)
|
void |
beforeFirst()
|
void |
close()
|
void |
close(java.lang.Exception reason)
|
boolean |
first()
|
ClonedServerEntry |
get()
|
java.util.List<EntryFilter> |
getEntryFilters()
Gets an unmodifiable list of EntryFilters applied. |
SearchingOperationContext |
getOperationContext()
|
boolean |
isAbandoned()
Gets whether or not this BaseEntryFilteringCursor has been abandoned. |
boolean |
isAfterLast()
|
boolean |
isBeforeFirst()
|
boolean |
isClosed()
|
boolean |
isElementReused()
|
boolean |
isFirst()
|
boolean |
isLast()
|
java.util.Iterator<ClonedServerEntry> |
iterator()
|
boolean |
last()
|
boolean |
next()
|
boolean |
previous()
|
boolean |
removeEntryFilter(EntryFilter filter)
Removes an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. |
void |
setAbandoned(boolean abandoned)
Sets whether this BaseEntryFilteringCursor has been abandoned. |
void |
setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CursorList(int start, java.util.List<EntryFilteringCursor> list, int end, SearchingOperationContext opContext)
start
- the lower bound indexlist
- the list this ListCursor operates onend
- the upper bound indexpublic CursorList(java.util.List<EntryFilteringCursor> list, SearchingOperationContext opContext)
list
- the backing for this ListCursorMethod Detail |
---|
public boolean available()
available
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public void before(ClonedServerEntry element) throws java.lang.Exception
before
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.IllegalStateException
- if the underlying list is not sorted
and/or a comparator is not provided.
java.lang.Exception
public void after(ClonedServerEntry element) throws java.lang.Exception
after
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void beforeFirst() throws java.lang.Exception
beforeFirst
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void afterLast() throws java.lang.Exception
afterLast
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean first() throws java.lang.Exception
first
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean last() throws java.lang.Exception
last
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean isFirst() throws java.lang.Exception
java.lang.Exception
public boolean isLast() throws java.lang.Exception
java.lang.Exception
public boolean isAfterLast() throws java.lang.Exception
java.lang.Exception
public boolean isBeforeFirst() throws java.lang.Exception
java.lang.Exception
public boolean previous() throws java.lang.Exception
previous
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean next() throws java.lang.Exception
next
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public ClonedServerEntry get() throws java.lang.Exception
get
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean isElementReused()
isElementReused
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public boolean addEntryFilter(EntryFilter filter)
EntryFilteringCursor
addEntryFilter
in interface EntryFilteringCursor
filter
- a filter to apply to the entries
List.add(Object)
public java.util.List<EntryFilter> getEntryFilters()
EntryFilteringCursor
getEntryFilters
in interface EntryFilteringCursor
public SearchingOperationContext getOperationContext()
getOperationContext
in interface EntryFilteringCursor
public boolean isAbandoned()
EntryFilteringCursor
isAbandoned
in interface EntryFilteringCursor
public boolean removeEntryFilter(EntryFilter filter)
EntryFilteringCursor
removeEntryFilter
in interface EntryFilteringCursor
filter
- a filter to remove from the filter list
List.remove(Object)
public void setAbandoned(boolean abandoned)
EntryFilteringCursor
setAbandoned
in interface EntryFilteringCursor
abandoned
- true if abandoned, false if notpublic void close() throws java.lang.Exception
close
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void close(java.lang.Exception reason) throws java.lang.Exception
close
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean isClosed() throws java.lang.Exception
isClosed
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public java.util.Iterator<ClonedServerEntry> iterator()
iterator
in interface java.lang.Iterable<ClonedServerEntry>
public void setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)
setClosureMonitor
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |