001/*
002 * Copyright 2011-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2011-2023 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2011-2023 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.util.InternalUseOnly;
043import com.unboundid.util.Mutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This class provides a basic implementation of the
053 * {@link AsyncCompareResultListener} interface that will merely set the
054 * result object to a local variable that can be accessed through a getter
055 * method.  It provides a listener that may be easily used when processing
056 * an asynchronous compare operation using the {@link AsyncRequestID} as a
057 * {@code java.util.concurrent.Future} object.
058 */
059@Mutable()
060@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
061public final class BasicAsyncCompareResultListener
062       implements AsyncCompareResultListener, Serializable
063{
064  /**
065   * The serial version UID for this serializable class.
066   */
067  private static final long serialVersionUID = 8119461093491566432L;
068
069
070
071  // The compare result that has been received for the associated compare
072  // operation.
073  @Nullable private volatile CompareResult compareResult;
074
075
076
077  /**
078   * Creates a new instance of this class for use in processing a single
079   * compare operation.  A single basic async compare result listener object
080   * may not be used for multiple operations.
081   */
082  public BasicAsyncCompareResultListener()
083  {
084    compareResult = null;
085  }
086
087
088
089  /**
090   * {@inheritDoc}
091   */
092  @InternalUseOnly()
093  @Override()
094  public void compareResultReceived(@NotNull final AsyncRequestID requestID,
095                                    @NotNull final CompareResult compareResult)
096  {
097    this.compareResult = compareResult;
098  }
099
100
101
102  /**
103   * Retrieves the result that has been received for the associated asynchronous
104   * compare operation, if it has been received.
105   *
106   * @return  The result that has been received for the associated asynchronous
107   *          compare operation, or {@code null} if no response has been
108   *          received yet.
109   */
110  @Nullable()
111  public CompareResult getCompareResult()
112  {
113    return compareResult;
114  }
115}