io.atlassian.util.concurrent.atomic.AtomicReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlassian-util-concurrent Show documentation
This project contains utility classes that are used by various products and projects inside Atlassian and may have some utility to the world at large.
The newest version!
/**
 * Copyright 2008 Atlassian Pty Ltd 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at 
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License.
 */

package io.atlassian.util.concurrent.atomic;

import java.util.function.Function;
import java.util.function.Supplier;

/**
 * AtomicReference with richer functionality. This class implements commonly
 * implemented patterns of use of compareAndSet such as
 * {@link #getOrSetAndGetIf(Object, Object)} and {@link #update(Function)}.
 *
 * @since 0.0.12
 */
public class AtomicReference extends java.util.concurrent.atomic.AtomicReference {

  private static final long serialVersionUID = -6792744642556679378L;

  //
  // ctors
  //

  /**
   * Creates a new AtomicReference with null initial value.
   */
  public AtomicReference() {}

  /**
   * Creates a new AtomicReference with the given initial value.
   *
   * @param initialValue the initial value
   */
  public AtomicReference(final V initialValue) {
    super(initialValue);
  }

  //
  // methods
  //

  /**
   * Check the current value and if it matches the old value argument, set it to
   * the one created by the {@link Supplier new value supplier} and return that
   * instead. If the old value argument does not match, ignore both and just
   * return the current value.
   *
   * @param oldValue to check the current value against (reference equality
   * check only).
   * @param newValue a {@link java.util.function.Supplier} for a new value. May
   * be called more than once.
   * @return the current reference value if it doesn't match old value or a
   * newly created value.
   */
  public final V getOrSetAndGetIf(final V oldValue, final Supplier newValue) {
    V result = get();
    // loop until invariant is true in case some other thread resets
    // reference to oldValue (although if they are doing that then we still
    // cannot guarantee there will be no ABA problem as they could come
    // back and set it after we return)
    while (result == oldValue) {
      final V update = newValue.get();
      // abort if trying to set the same value, otherwise infinite loop
      if (update == oldValue) {
        return oldValue;
      }
      compareAndSet(oldValue, update);
      result = get();
    }
    return result;
  }

  /**
   * Check the current value and if it matches the old value argument, set it to
   * the new value and return that instead. If the old value argument does not
   * match, ignore both and just return the current value.
   *
   * @param oldValue to check the current value against (reference equality
   * check only)
   * @param newValue the new value to set it to
   * @return the current reference value if it doesn't match oldValue or a newly
   * created value.
   */
  public final V getOrSetAndGetIf(final V oldValue, final V newValue) {
    V result = get();
    // loop until invariant is true in case some other thread resets
    // reference to oldValue (although if they are doing that then we still
    // cannot guarantee there will be no ABA problem as they could come
    // back and set it after we return)
    while (result == oldValue) {
      // abort if trying to set the same value, otherwise infinite loop
      if (result == newValue) {
        return result;
      }
      compareAndSet(oldValue, newValue);
      result = get();
    }
    return result;
  }

  /**
   * Do the actual update. Calls the factory method with the old value to do the
   * update logic, then sets the value to that if it hasn't changed in the
   * meantime.
   *
   * @return the new updated value.
   * @param newValueFactory a {@link java.util.function.Function} object.
   */
  public final V update(final Function newValueFactory) {
    V oldValue, newValue;
    do {
      oldValue = get();
      newValue = newValueFactory.apply(oldValue);
      // test first to implement TTAS optimisation
      // then compare and set
    } while ((get() != oldValue) || !compareAndSet(oldValue, newValue));
    return newValue;
  }
}