public class BaseEntryFilteringCursor extends Object implements EntryFilteringCursor
Constructor and Description |
---|
BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped,
SearchingOperationContext operationContext)
Creates a new entry filtering Cursor over an existing Cursor using a
no filter initially: more can be added later after creation.
|
BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped,
SearchingOperationContext operationContext,
EntryFilter filter)
Creates a new entry filtering Cursor over an existing Cursor using a
single filter initially: more can be added later after creation.
|
BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped,
SearchingOperationContext operationContext,
List<EntryFilter> filters)
Creates a new entry filtering Cursor over an existing Cursor using a
list of filters initially: more can be added later after creation.
|
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 |
isClosed() |
boolean |
isElementReused() |
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) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped, SearchingOperationContext operationContext, EntryFilter filter)
wrapped
- the underlying wrapped Cursor whose entries are filteredsearchControls
- the controls of search that created this Cursorinvocation
- the search operation invocation creating this Cursorfilter
- a single filter to be usedpublic BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped, SearchingOperationContext operationContext)
wrapped
- the underlying wrapped Cursor whose entries are filteredsearchControls
- the controls of search that created this Cursorinvocation
- the search operation invocation creating this Cursorfilter
- a single filter to be usedpublic BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped, SearchingOperationContext operationContext, List<EntryFilter> filters)
wrapped
- the underlying wrapped Cursor whose entries are filteredoperationContext
- the operation context that created this Cursorinvocation
- the search operation invocation creating this Cursorfilters
- a list of filters to be usedpublic boolean isAbandoned()
EntryFilteringCursor
isAbandoned
in interface EntryFilteringCursor
public void setAbandoned(boolean abandoned)
EntryFilteringCursor
setAbandoned
in interface EntryFilteringCursor
abandoned
- true if abandoned, false if notpublic boolean addEntryFilter(EntryFilter filter)
EntryFilteringCursor
addEntryFilter
in interface EntryFilteringCursor
filter
- a filter to apply to the entriesList.add(Object)
public boolean removeEntryFilter(EntryFilter filter)
EntryFilteringCursor
removeEntryFilter
in interface EntryFilteringCursor
filter
- a filter to remove from the filter listList.remove(Object)
public List<EntryFilter> getEntryFilters()
EntryFilteringCursor
getEntryFilters
in interface EntryFilteringCursor
public SearchingOperationContext getOperationContext()
getOperationContext
in interface EntryFilteringCursor
public void after(ClonedServerEntry element) throws Exception
after
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 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>
Exception
public void beforeFirst() throws Exception
beforeFirst
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public 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 final void setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)
setClosureMonitor
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public boolean first() throws Exception
first
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 isClosed() throws Exception
isClosed
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 last() throws Exception
last
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 boolean previous() throws Exception
previous
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
Exception
public Iterator<ClonedServerEntry> iterator()
iterator
in interface Iterable<ClonedServerEntry>
Copyright © 2003–2015 The Apache Software Foundation. All rights reserved.