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

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

public class ModifyFuture
extends ResponseFuture<ModifyResponse>

A Future to manage ModifyRequest

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

ModifyFuture

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

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

get

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

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

get

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

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


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