org.apache.directory.server.xdbm

Class SingletonIndexCursor<V>

java.lang.Object

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

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

org.apache.directory.server.xdbm.SingletonIndexCursor<V>

All Implemented Interfaces:

java.lang.Iterable<IndexEntry<V,java.lang.String>>, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>

public class SingletonIndexCursor<V>
extends AbstractIndexCursor<V>

A Cursor over a single element.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	afterLast
private boolean	beforeFirst
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private boolean	onSingleton
private IndexEntry<V,java.lang.String>	singleton

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

UNSUPPORTED_MSG

Constructor Summary

Constructors

Constructor and Description
SingletonIndexCursor(IndexEntry<V,java.lang.String> singleton)

Method Summary

Modifier and Type	Method and Description
void	afterLast()
boolean	available()
void	beforeFirst()
void	close()
void	close(java.lang.Exception cause)
boolean	first()
IndexEntry<V,java.lang.String>	get()
protected java.lang.String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	isAfterLast()
boolean	isBeforeFirst()
boolean	isFirst()
boolean	isLast()
boolean	last()
boolean	next()
boolean	previous()

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

after, before, setAvailable

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

checkNotClosed, isClosed, 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

Field Detail

LOG_CURSOR

private static final org.slf4j.Logger LOG_CURSOR

A dedicated log for cursors

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

beforeFirst

private boolean beforeFirst

afterLast

private boolean afterLast

onSingleton

private boolean onSingleton

singleton

private final IndexEntry<V,java.lang.String> singleton

Constructor Detail

SingletonIndexCursor

public SingletonIndexCursor(IndexEntry<V,java.lang.String> singleton)

Method Detail

getUnsupportedMessage

protected java.lang.String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<V>

Returns:

The Unsupported message

available

public boolean available()

Description copied from class: AbstractIndexCursor

Specified by:

available in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>

Overrides:

available in class AbstractIndexCursor<V>

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

isFirst

public boolean isFirst()

Specified by:

isFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>

Overrides:

isFirst in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,java.lang.String>>

isLast

public boolean isLast()

Specified by:

isLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>

Overrides:

isLast in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,java.lang.String>>

isAfterLast

public boolean isAfterLast()

Specified by:

isAfterLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>

Overrides:

isAfterLast in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,java.lang.String>>

isBeforeFirst

public boolean isBeforeFirst()

Specified by:

isBeforeFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>

Overrides:

isBeforeFirst in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,java.lang.String>>

previous

public boolean previous()
                 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

next

public boolean next()
             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

get

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

Throws:

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

close

public void close()

Specified by:

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

Overrides:

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

close

public void close(java.lang.Exception cause)

Specified by:

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

Overrides:

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