// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.util;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.errorprone.annotations.FormatMethod;
import com.google.errorprone.annotations.FormatString;
import java.util.Optional;
import javax.annotation.Nullable;

/** Utility methods related to preconditions checking. */
public class PreconditionsUtils {

  /**
   * Checks whether the provided reference is null, throws IAE if it is, and returns it if not.
   *
   * <p>This method and its overloads are to substitute for checkNotNull() in cases where it's
   * preferable to throw an IAE instead of an NPE, such as where we want an IAE to indicate that
   * it's just a bad argument/parameter and reserve NPEs for bugs and unexpected null values.
   */
  public static <T> T checkArgumentNotNull(@Nullable T reference) {
    checkArgument(reference != null);
    return reference;
  }

  /** Checks whether the provided reference is null, throws IAE if it is, and returns it if not. */
  public static <T> T checkArgumentNotNull(@Nullable T reference, @Nullable Object errorMessage) {
    checkArgument(reference != null, errorMessage);
    return reference;
  }

  /** Checks whether the provided reference is null, throws IAE if it is, and returns it if not. */
  @FormatMethod
  public static <T> T checkArgumentNotNull(
      @Nullable T reference,
      @Nullable @FormatString String errorMessageTemplate,
      @Nullable Object... errorMessageArgs) {
    checkArgument(reference != null, errorMessageTemplate, errorMessageArgs);
    return reference;
  }

  /** Checks if the provided Optional is present, returns its value if so, and throws IAE if not. */
  public static <T> T checkArgumentPresent(@Nullable Optional<T> reference) {
    checkArgumentNotNull(reference);
    checkArgument(reference.isPresent());
    return reference.get();
  }

  /** Checks if the provided Optional is present, returns its value if so, and throws IAE if not. */
  public static <T> T checkArgumentPresent(
      @Nullable Optional<T> reference, @Nullable Object errorMessage) {
    checkArgumentNotNull(reference, errorMessage);
    checkArgument(reference.isPresent(), errorMessage);
    return reference.get();
  }

  /** Checks if the provided Optional is present, returns its value if so, and throws IAE if not. */
  @FormatMethod
  public static <T> T checkArgumentPresent(
      @Nullable Optional<T> reference,
      @Nullable @FormatString String errorMessageTemplate,
      @Nullable Object... errorMessageArgs) {
    checkArgumentNotNull(reference, errorMessageTemplate, errorMessageArgs);
    checkArgument(reference.isPresent(), errorMessageTemplate, errorMessageArgs);
    return reference.get();
  }
}
