public class EntryFilteringCursorImpl extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry> implements EntryFilteringCursor
Constructor and Description |
---|
EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped,
SearchOperationContext operationContext,
org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
Creates a new entry filtering Cursor over an existing Cursor using a
no filter initially: more can be added later after creation.
|
EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped,
SearchOperationContext operationContext,
org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
EntryFilter filter)
Creates a new entry filtering Cursor over an existing Cursor using a
single filter initially: more can be added later after creation.
|
EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped,
SearchOperationContext operationContext,
org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
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(org.apache.directory.api.ldap.model.entry.Entry element) |
void |
afterLast() |
boolean |
available() |
void |
before(org.apache.directory.api.ldap.model.entry.Entry element) |
void |
beforeFirst() |
void |
close() |
void |
close(Exception reason) |
boolean |
first() |
org.apache.directory.api.ldap.model.entry.Entry |
get() |
List<EntryFilter> |
getEntryFilters()
Gets an unmodifiable list of EntryFilters applied.
|
SearchOperationContext |
getOperationContext() |
boolean |
isAbandoned() |
boolean |
isClosed() |
boolean |
last() |
boolean |
next() |
boolean |
previous() |
boolean |
removeEntryFilter(EntryFilter filter) |
void |
setAbandoned(boolean abandoned) |
void |
setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor) |
String |
toString() |
String |
toString(String tabs) |
checkNotClosed, isAfterLast, isBeforeFirst, isFirst, isLast, iterator
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
isAfterLast, isBeforeFirst, isFirst, isLast
forEach, iterator, spliterator
public EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped, SearchOperationContext operationContext, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, EntryFilter filter)
wrapped
- the underlying wrapped Cursor whose entries are filteredschemaManager
- The SchemaManager instanceoperationContext
- The OperationContext instancefilter
- a single filter to be usedpublic EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped, SearchOperationContext operationContext, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
wrapped
- the underlying wrapped Cursor whose entries are filteredoperationContext
- The OperationContext instanceschemaManager
- The SchemaManager instancepublic EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped, SearchOperationContext operationContext, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, List<EntryFilter> filters)
wrapped
- the underlying wrapped Cursor whose entries are filteredoperationContext
- the operation context that created this CursorschemaManager
- The SchemaManager instancefilters
- a list of filters to be usedpublic boolean isAbandoned()
public void setAbandoned(boolean abandoned)
public boolean addEntryFilter(EntryFilter filter)
EntryFilteringCursor
addEntryFilter
in interface EntryFilteringCursor
filter
- a filter to apply to the entriesList.add(Object)
public boolean removeEntryFilter(EntryFilter filter)
public List<EntryFilter> getEntryFilters()
getEntryFilters
in interface EntryFilteringCursor
public SearchOperationContext getOperationContext()
getOperationContext
in interface EntryFilteringCursor
public void after(org.apache.directory.api.ldap.model.entry.Entry element) throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
after
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public void afterLast() throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
afterLast
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public boolean available()
available
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
public void before(org.apache.directory.api.ldap.model.entry.Entry element) throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
before
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public void beforeFirst() throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
beforeFirst
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
IOException
public void close(Exception reason) throws IOException
close
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
close
in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
IOException
public final void setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)
setClosureMonitor
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
setClosureMonitor
in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
public boolean first() throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
first
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public org.apache.directory.api.ldap.model.entry.Entry get() throws org.apache.directory.api.ldap.model.cursor.InvalidCursorPositionException
get
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.cursor.InvalidCursorPositionException
public boolean isClosed()
isClosed
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
isClosed
in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
public boolean last() throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
last
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public boolean next() throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
next
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public boolean previous() throws org.apache.directory.api.ldap.model.exception.LdapException, org.apache.directory.api.ldap.model.cursor.CursorException
previous
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.cursor.CursorException
public String toString(String tabs)
toString
in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>
toString
in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
Object.toString()
public String toString()
toString
in class Object
Object.toString()
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.