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

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

public class AddFuture
extends ResponseFuture<AddResponse>

A Future to manage AddRequests

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
AddFuture(LdapConnection connection, int messageId)
          Creates a new instance of AddFuture.
 
Method Summary
 AddResponse get()
          Get the AddResponse, blocking until one is received.
 AddResponse get(long timeout, java.util.concurrent.TimeUnit unit)
          Get the AddResponse, 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

AddFuture

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

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

get

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

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

get

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

Specified by:
get in interface java.util.concurrent.Future<AddResponse>
Overrides:
get in class ResponseFuture<AddResponse>
Parameters:
timeout - Number of TimeUnit to wait
unit - The TimeUnit
Returns:
The AddResponse The AddResponse 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<AddResponse>


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