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

java.lang.Object
  org.apache.directory.ldap.client.api.future.ResponseFuture<org.apache.directory.api.ldap.model.message.CompareResponse>
      org.apache.directory.ldap.client.api.future.CompareFuture

All Implemented Interfaces:

Future<org.apache.directory.api.ldap.model.message.Response>

public class CompareFuture
extends ResponseFuture<org.apache.directory.api.ldap.model.message.CompareResponse>

A Future to manage CompareRequest.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.ldap.client.api.future.ResponseFuture

cancelled, cause, connection, messageId, queue

Constructor Summary

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

Method Summary

org.apache.directory.api.ldap.model.message.CompareResponse	get() Get the CompareResponse, blocking until one is received.
org.apache.directory.api.ldap.model.message.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, cancel, getCause, isCancelled, isDone, set, setCause

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 LDAP connection

messageId - the associated messageId

Method Detail

get

public org.apache.directory.api.ldap.model.message.CompareResponse get()
                                                                throws InterruptedException,
                                                                       ExecutionException

Get the CompareResponse, blocking until one is received.

Specified by:

get in interface Future<org.apache.directory.api.ldap.model.message.Response>

Overrides:

get in class ResponseFuture<org.apache.directory.api.ldap.model.message.CompareResponse>

Returns:

the compare response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

get

public org.apache.directory.api.ldap.model.message.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<org.apache.directory.api.ldap.model.message.Response>

Overrides:

get in class ResponseFuture<org.apache.directory.api.ldap.model.message.CompareResponse>

Parameters:

timeout -

unit -

Returns:

the compare response

Throws:

InterruptedException - if the operation has been cancelled by client

ExecutionException

TimeoutException

toString

public String toString()

Overrides:

toString in class ResponseFuture<org.apache.directory.api.ldap.model.message.CompareResponse>