org.apache.directory.ldap.client.api.future
Class CompareFuture

java.lang.Object
  extended by org.apache.directory.ldap.client.api.future.ResponseFuture<CompareResponse>
      extended by org.apache.directory.ldap.client.api.future.CompareFuture
All Implemented Interfaces:
java.util.concurrent.Future<CompareResponse>

public class CompareFuture
extends ResponseFuture<CompareResponse>

A Future to manage CompareRequest

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

Field Summary
 
Fields inherited from class org.apache.directory.ldap.client.api.future.ResponseFuture
cancelled, connection, messageId, queue
 
Constructor Summary
CompareFuture(LdapConnection connection, int messageId)
          Creates a new instance of CompareFuture.
 
Method Summary
 CompareResponse get()
          Get the CompareResponse, blocking until one is received.
 CompareResponse get(long timeout, java.util.concurrent.TimeUnit unit)
          Get the CompareResponse, blocking until one is received, or until the given timeout is reached.
 java.lang.String toString()
          
 
Methods inherited from class org.apache.directory.ldap.client.api.future.ResponseFuture
cancel, isCancelled, isDone, set
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompareFuture

public CompareFuture(LdapConnection connection,
                     int messageId)
Creates a new instance of CompareFuture.

Parameters:
connection - The LdapConnection
messageId - The associated messageId
Method Detail

get

public CompareResponse get()
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException
Get the CompareResponse, blocking until one is received.

Specified by:
get in interface java.util.concurrent.Future<CompareResponse>
Overrides:
get in class ResponseFuture<CompareResponse>
Returns:
The CompareResponse
Throws:
java.lang.InterruptedException - if the operation has been cancelled by client
java.util.concurrent.ExecutionException

get

public CompareResponse get(long timeout,
                           java.util.concurrent.TimeUnit unit)
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException,
                           java.util.concurrent.TimeoutException
Get the CompareResponse, blocking until one is received, or until the given timeout is reached.

Specified by:
get in interface java.util.concurrent.Future<CompareResponse>
Overrides:
get in class ResponseFuture<CompareResponse>
Parameters:
timeout - Number of TimeUnit to wait
unit - The TimeUnit
Returns:
The CompareResponse The CompareResponse found
Throws:
java.lang.InterruptedException - if the operation has been cancelled by client
java.util.concurrent.ExecutionException
java.util.concurrent.TimeoutException

toString

public java.lang.String toString()

Overrides:
toString in class ResponseFuture<CompareResponse>


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