org.apache.directory.server.xdbm
Class EmptyIndexCursor<K,E>

java.lang.Object
  org.apache.directory.server.xdbm.AbstractIndexCursor<K,E>
      org.apache.directory.server.xdbm.EmptyIndexCursor<K,E>

All Implemented Interfaces:

java.lang.Iterable<IndexEntry<K,E>>, IndexCursor<K,E>, org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<K,E>>

public class EmptyIndexCursor<K,E>
extends AbstractIndexCursor<K,E>

An empty Cursor implementation.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

EmptyIndexCursor()

Method Summary

void	after(IndexEntry<K,E> element)
void	afterLast()
void	afterValue(java.lang.Long id, K indexValue) An alternative to calling after(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation.
boolean	available()
void	before(IndexEntry<K,E> element)
void	beforeFirst()
void	beforeValue(java.lang.Long id, K indexValue) An alternative to calling before(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation.
boolean	first()
IndexEntry<K,E>	get()
boolean	isElementReused()
boolean	last()
boolean	next()
boolean	previous()

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

checkNotClosed, close, close, isClosed, iterator, setClosureMonitor

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyIndexCursor

public EmptyIndexCursor()

Method Detail

available

public boolean available()

before

public void before(IndexEntry<K,E> element)
            throws java.lang.Exception

Throws:

java.lang.Exception

after

public void after(IndexEntry<K,E> element)
           throws java.lang.Exception

Throws:

java.lang.Exception

beforeFirst

public void beforeFirst()
                 throws java.lang.Exception

Throws:

java.lang.Exception

afterLast

public void afterLast()
               throws java.lang.Exception

Throws:

java.lang.Exception

first

public boolean first()
              throws java.lang.Exception

Throws:

java.lang.Exception

last

public boolean last()
             throws java.lang.Exception

Throws:

java.lang.Exception

previous

public boolean previous()
                 throws java.lang.Exception

Throws:

java.lang.Exception

next

public boolean next()
             throws java.lang.Exception

Throws:

java.lang.Exception

get

public IndexEntry<K,E> get()
                    throws java.lang.Exception

Throws:

java.lang.Exception

isElementReused

public boolean isElementReused()

afterValue

public void afterValue(java.lang.Long id,
                       K indexValue)
                throws java.lang.Exception

Description copied from interface: IndexCursor

An alternative to calling after(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation. Some implementations may not support this operation and may throw an UnsupportedOperationEception.

Parameters:

id - the Long id for the entry

indexValue - the value to advance just after the last value

Throws:

java.lang.Exception - if there are faults peforming this operation

beforeValue

public void beforeValue(java.lang.Long id,
                        K indexValue)
                 throws java.lang.Exception

Description copied from interface: IndexCursor

An alternative to calling before(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation. Some implementations may not support this operation and may throw an UnsupportedOperationEception.

Parameters:

id - the Long id for the entry

indexValue - the value to advance just before

Throws:

java.lang.Exception - if there are faults peforming this operation