org.apache.directory.ldap.client.api
Class SearchCursor

java.lang.Object
  extended by org.apache.directory.shared.ldap.cursor.AbstractCursor
      extended by org.apache.directory.ldap.client.api.SearchCursor
All Implemented Interfaces:
java.lang.Iterable, org.apache.directory.shared.ldap.cursor.Cursor

public class SearchCursor
extends org.apache.directory.shared.ldap.cursor.AbstractCursor

An implementation of Cursor based on the underlying SearchFuture instance. Note: This is a forward only cursor hence the only valid operations are next(), get() and close()

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Constructor Summary
SearchCursor(SearchFuture future, long timeout, java.util.concurrent.TimeUnit timeUnit)
           
 
Method Summary
 void after(java.lang.Object element)
           
 void afterLast()
           
 boolean available()
           
 void before(java.lang.Object element)
           
 void beforeFirst()
           
 void close()
           
 void close(java.lang.Exception cause)
           
 boolean first()
           
 SearchResponse get()
           
 boolean isElementReused()
           
 boolean last()
           
 boolean next()
           
 boolean previous()
           
 
Methods inherited from class org.apache.directory.shared.ldap.cursor.AbstractCursor
checkNotClosed, isClosed, iterator, setClosureMonitor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchCursor

public SearchCursor(SearchFuture future,
                    long timeout,
                    java.util.concurrent.TimeUnit timeUnit)
Method Detail

next

public boolean next()
             throws java.lang.Exception
Throws:
java.lang.Exception

get

public SearchResponse get()
                   throws java.lang.Exception
Throws:
java.lang.Exception

isElementReused

public boolean isElementReused()

available

public boolean available()

close

public void close()
           throws java.lang.Exception
Specified by:
close in interface org.apache.directory.shared.ldap.cursor.Cursor
Overrides:
close in class org.apache.directory.shared.ldap.cursor.AbstractCursor
Throws:
java.lang.Exception

close

public void close(java.lang.Exception cause)
           throws java.lang.Exception
Specified by:
close in interface org.apache.directory.shared.ldap.cursor.Cursor
Overrides:
close in class org.apache.directory.shared.ldap.cursor.AbstractCursor
Throws:
java.lang.Exception

after

public void after(java.lang.Object element)
           throws java.lang.Exception
Throws:
java.lang.Exception

afterLast

public void afterLast()
               throws java.lang.Exception
Throws:
java.lang.Exception

before

public void before(java.lang.Object element)
            throws java.lang.Exception
Throws:
java.lang.Exception

beforeFirst

public void beforeFirst()
                 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


Copyright © 2009-2011 Apache Software Foundation. All Rights Reserved.