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

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

public class DeleteFuture
extends ResponseFuture<DeleteResponse>

A Future to manage DelRequests

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

DeleteFuture

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

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

get

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

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

get

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

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


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