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

Class CompareFuture

java.lang.Object

org.apache.directory.ldap.client.api.future.ResponseFuture<CompareResponse>

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

All Implemented Interfaces:

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

Constructors

Constructor and Description
CompareFuture(LdapConnection connection, int messageId) Creates a new instance of CompareFuture.

Method Summary

Modifier and Type	Method and Description
CompareResponse	get() Get the CompareResponse, blocking until one is received.
CompareResponse	get(long timeout, TimeUnit unit) Get the CompareResponse, blocking until one is received, or until the given timeout is reached.
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 InterruptedException,
                           ExecutionException

Get the CompareResponse, blocking until one is received.

Specified by:

get in interface Future<CompareResponse>

Overrides:

get in class ResponseFuture<CompareResponse>

Returns:

The CompareResponse

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public CompareResponse get(long timeout,
                           TimeUnit unit)
                    throws InterruptedException,
                           ExecutionException,
                           TimeoutException

Get the CompareResponse, blocking until one is received, or until the given timeout is reached.

Specified by:

get in interface 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:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<CompareResponse>