public class CursorList extends Object implements EntryFilteringCursor
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 internallyConstructor and Description |
---|
CursorList(int start,
List<EntryFilteringCursor> list,
int end,
SearchingOperationContext opContext)
Creates a new ListCursor with lower (inclusive) and upper (exclusive)
bounds.
|
CursorList(List<EntryFilteringCursor> list,
SearchingOperationContext opContext)
Creates a new ListCursor without specific bounds: the bounds are
acquired from the size of the list.
|
Modifier and Type | Method and Description |
---|---|
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(Exception reason) |
boolean |
first() |
ClonedServerEntry |
get() |
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() |
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) |
public CursorList(int start, List<EntryFilteringCursor> list, int end, SearchingOperationContext opContext)
start
- the lower bound indexlist
- the list this ListCursor operates onend
- the upper bound indexpublic CursorList(List<EntryFilteringCursor> list, SearchingOperationContext opContext)
list
- the backing for this ListCursorpublic boolean available()
available
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public void before(ClonedServerEntry element) throws Exception
before
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
IllegalStateException
- if the underlying list is not sorted
and/or a comparator is not provided.Exception
public void after(ClonedServerEntry element) throws Exception
after
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public void beforeFirst() throws Exception
beforeFirst
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public void afterLast() throws Exception
afterLast
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public boolean first() throws Exception
first
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public boolean last() throws Exception
last
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public boolean previous() throws Exception
previous
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public boolean next() throws Exception
next
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public ClonedServerEntry get() throws Exception
get
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
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 entriesList.add(Object)
public 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 listList.remove(Object)
public void setAbandoned(boolean abandoned)
EntryFilteringCursor
setAbandoned
in interface EntryFilteringCursor
abandoned
- true if abandoned, false if notpublic void close() throws Exception
close
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public void close(Exception reason) throws Exception
close
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public boolean isClosed() throws Exception
isClosed
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public Iterator<ClonedServerEntry> iterator()
iterator
in interface Iterable<ClonedServerEntry>
public void setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)
setClosureMonitor
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Copyright © 2003-2012 Apache Software Foundation. All Rights Reserved.