001/* 002 * Copyright 2011-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2011-2020 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-2020 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.ThreadSafety; 045import com.unboundid.util.ThreadSafetyLevel; 046 047 048 049/** 050 * This class provides a basic implementation of the 051 * {@link AsyncCompareResultListener} interface that will merely set the 052 * result object to a local variable that can be accessed through a getter 053 * method. It provides a listener that may be easily used when processing 054 * an asynchronous compare operation using the {@link AsyncRequestID} as a 055 * {@code java.util.concurrent.Future} object. 056 */ 057@Mutable() 058@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE) 059public final class BasicAsyncCompareResultListener 060 implements AsyncCompareResultListener, Serializable 061{ 062 /** 063 * The serial version UID for this serializable class. 064 */ 065 private static final long serialVersionUID = 8119461093491566432L; 066 067 068 069 // The compare result that has been received for the associated compare 070 // operation. 071 private volatile CompareResult compareResult; 072 073 074 075 /** 076 * Creates a new instance of this class for use in processing a single 077 * compare operation. A single basic async compare result listener object 078 * may not be used for multiple operations. 079 */ 080 public BasicAsyncCompareResultListener() 081 { 082 compareResult = null; 083 } 084 085 086 087 /** 088 * {@inheritDoc} 089 */ 090 @InternalUseOnly() 091 @Override() 092 public void compareResultReceived(final AsyncRequestID requestID, 093 final CompareResult compareResult) 094 { 095 this.compareResult = compareResult; 096 } 097 098 099 100 /** 101 * Retrieves the result that has been received for the associated asynchronous 102 * compare operation, if it has been received. 103 * 104 * @return The result that has been received for the associated asynchronous 105 * compare operation, or {@code null} if no response has been 106 * received yet. 107 */ 108 public CompareResult getCompareResult() 109 { 110 return compareResult; 111 } 112}