org.apache.directory.server.xdbm

Class EmptyIndexCursor<K>

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

org.apache.directory.server.xdbm.AbstractIndexCursor<K>

org.apache.directory.server.xdbm.EmptyIndexCursor<K>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<IndexEntry<K,String>>, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

public class EmptyIndexCursor<K>
extends AbstractIndexCursor<K>

An empty Cursor implementation.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

partitionTxn, UNSUPPORTED_MSG

Constructor Summary

Constructors

Constructor and Description
EmptyIndexCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)

Method Summary

Modifier and Type	Method and Description
void	after(IndexEntry<K,String> element)
void	afterLast()
void	afterValue(String id, K indexValue)
void	before(IndexEntry<K,String> element)
void	beforeFirst()
void	beforeValue(String id, K indexValue)
void	close()
void	close(Exception cause)
boolean	first()
IndexEntry<K,String>	get()
protected String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	last()
boolean	next()
boolean	previous()

Methods inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

available, setAvailable

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EmptyIndexCursor

public EmptyIndexCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)

Method Detail

before

public void before(IndexEntry<K,String> element)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

before in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

before in class AbstractIndexCursor<K>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

getUnsupportedMessage

protected String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<K>

Returns:

The Unsupported message

after

public void after(IndexEntry<K,String> element)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

after in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

after in class AbstractIndexCursor<K>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

previous in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

previous in class AbstractIndexCursor<K>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

next in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

next in class AbstractIndexCursor<K>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

get

public IndexEntry<K,String> get()
                         throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.cursor.CursorException

afterValue

public void afterValue(String id,
                       K indexValue)
                throws Exception

Throws:

Exception

beforeValue

public void beforeValue(String id,
                        K indexValue)
                 throws Exception

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

Throws:

IOException

close

public void close(Exception cause)
           throws IOException

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

Throws:

IOException