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

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

public class ModifyDnFuture
extends ResponseFuture<ModifyDnResponse>

A Future to manage ModifyDnRequest

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

ModifyDnFuture

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

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

get

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

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

get

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

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


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