BasicAsyncCompareResultListener (UnboundID LDAP SDK for Java 4.0.14)

java.lang.Object
- com.unboundid.ldap.sdk.BasicAsyncCompareResultListener

All Implemented Interfaces:

AsyncCompareResultListener, java.io.Serializable
```
@Mutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class BasicAsyncCompareResultListener
extends java.lang.Object
implements AsyncCompareResultListener, java.io.Serializable
```
This class provides a basic implementation of the AsyncCompareResultListener interface that will merely set the result object to a local variable that can be accessed through a getter method. It provides a listener that may be easily used when processing an asynchronous compare operation using the AsyncRequestID as a java.util.concurrent.Future object.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

BasicAsyncCompareResultListener()
Creates a new instance of this class for use in processing a single compare operation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`compareResultReceived(AsyncRequestID requestID, CompareResult compareResult)`	Indicates that the provided LDAP result has been received in response to an asynchronous compare operation.
`CompareResult`	`getCompareResult()`	Retrieves the result that has been received for the associated asynchronous compare operation, if it has been received.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BasicAsyncCompareResultListener
```
public BasicAsyncCompareResultListener()
```
    Creates a new instance of this class for use in processing a single compare operation. A single basic async compare result listener object may not be used for multiple operations.
- Method Detail
  - compareResultReceived
```
@InternalUseOnly
public void compareResultReceived(AsyncRequestID requestID,
                                  CompareResult compareResult)
```
    Indicates that the provided LDAP result has been received in response to an asynchronous compare operation. Note that automatic referral following is not supported for asynchronous operations, so it is possible that this result could include a referral.
    
    Specified by:
    
    compareResultReceived in interface AsyncCompareResultListener
    
    Parameters:
    
    requestID - The async request ID of the request for which the response was received.
    
    compareResult - The compare result that has been received.
  - getCompareResult
```
public CompareResult getCompareResult()
```
    Retrieves the result that has been received for the associated asynchronous compare operation, if it has been received.
    
    Returns:
    
    The result that has been received for the associated asynchronous compare operation, or null if no response has been received yet.