org.apache.ratis.util.MemoizedCheckedSupplier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ratis-common Show documentation
There is a newer version: 3.1.2
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.ratis.util;

import org.apache.ratis.util.function.CheckedSupplier;

import java.util.Objects;

/**
 * A memoized supplier is a {@link CheckedSupplier}
 * which gets a value by invoking its initializer once.
 * and then keeps returning the same value as its supplied results.
 *
 * This class is thread safe.
 *
 * @param  The return type of the supplier.
 * @param  The throwable type of the supplier.
 */
public final class MemoizedCheckedSupplier
    implements CheckedSupplier {
  /**
   * @param supplier to supply at most one non-null value.
   * @return a {@link MemoizedCheckedSupplier} with the given supplier.
   */
  public static  MemoizedCheckedSupplier valueOf(
      CheckedSupplier supplier) {
    return supplier instanceof MemoizedCheckedSupplier ?
        (MemoizedCheckedSupplier) supplier : new MemoizedCheckedSupplier<>(supplier);
  }

  private final CheckedSupplier initializer;

  @SuppressWarnings({"squid:S3077"}) // Suppress volatile for generic type
  private volatile RETURN value = null;

  /**
   * Create a memoized supplier.
   * @param initializer to supply at most one non-null value.
   */
  private MemoizedCheckedSupplier(CheckedSupplier initializer) {
    Objects.requireNonNull(initializer, "initializer == null");
    this.initializer = initializer;
  }

  /** @return the lazily initialized object. */
  @Override
  public RETURN get() throws THROW {
    RETURN v = value;
    if (v == null) {
      synchronized (this) {
        v = value;
        if (v == null) {
          v = value = Objects.requireNonNull(initializer.get(), "initializer.get() returns null");
        }
      }
    }
    return v;
  }

  /**
   * @return the already initialized object.
   * @throws NullPointerException if the object is uninitialized.
   */
  public RETURN getUnchecked() {
    return Objects.requireNonNull(value, "value == null");
  }

  /** @return is the object initialized? */
  public boolean isInitialized() {
    return value != null;
  }

  @Override
  public String toString() {
    return isInitialized()? "Memoized:" + value: "UNINITIALIZED";
  }
}