/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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.micronaut.core.util;

import edu.umd.cs.findbugs.annotations.NonNull;

Utility methods for checking method argument values.
Author:
Graeme Rocher
Since:
1.0/**
 * Utility methods for checking method argument values.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public class ArgumentUtils {

    
Adds a check that the given number is positive.
Params:
name – The name of the argument
value – The value
Throws:
IllegalArgumentException – if the argument is not positive
Returns:
The value/**
     * Adds a check that the given number is positive.
     *
     * @param name The name of the argument
     * @param value The value
     * @throws IllegalArgumentException if the argument is not positive
     * @return The value
     */
    public static @NonNull Number requirePositive(String name, Number value) {
        requireNonNull(name, value);
        requirePositive(name, value.intValue());
        return value;
    }

    
Adds a check that the given number is not null.
Params:
name – The name of the argument
value – The value
Type parameters:
<T> – The generic type
Throws:
NullPointerException – if the argument is null
Returns:
The value/**
     * Adds a check that the given number is not null.
     *
     * @param name The name of the argument
     * @param value The value
     * @param <T> The generic type
     * @throws NullPointerException if the argument is null
     * @return The value
     */
    public static <T> T requireNonNull(String name, T value) {
        if (value == null) {
            throw new NullPointerException("Argument [" + name + "] cannot be null");
        }
        return value;
    }

    
Adds a check that the given number is positive.
Params:
name – The name of the argument
value – The value
Throws:
IllegalArgumentException – if the argument is not positive
Returns:
The value/**
     * Adds a check that the given number is positive.
     *
     * @param name The name of the argument
     * @param value The value
     * @throws IllegalArgumentException if the argument is not positive
     * @return The value
     */
    public static int requirePositive(String name, int value) {
        if (value < 0) {
            throw new IllegalArgumentException("Argument [" + name + "] cannot be negative");
        }
        return value;
    }

    
Perform a check on an argument.
Params:
check – The check
Returns:
The ArgumentCheck/**
     * Perform a check on an argument.
     *
     * @param check The check
     * @return The {@link ArgumentCheck}
     */
    public static ArgumentCheck check(Check check) {
        return new ArgumentCheck(check);
    }

    
Perform a check on an argument.
Params:
name –  The name of the argument
value – The value of the argument
Type parameters:
<T> –   The value type
Returns:
The ArgumentCheck/**
     * Perform a check on an argument.
     *
     * @param name  The name of the argument
     * @param value The value of the argument
     * @param <T>   The value type
     * @return The {@link ArgumentCheck}
     */
    public static <T> ArgumentCheck check(String name, T value) {
        return new ArgumentCheck<>(name, value);
    }

    
Allows producing error messages.
Type parameters:
<T> – The type/**
     * Allows producing error messages.
     *
     * @param <T> The type
     */
    public static class ArgumentCheck<T> {
        private final Check check;
        private final String name;
        private final T value;

        
Params:
check – The check/**
         * @param check The check
         */
        public ArgumentCheck(Check check) {
            this.check = check;
            this.name = null;
            this.value = null;
        }

        
Params:
name –  The name
value – The value/**
         * @param name  The name
         * @param value The value
         */
        public ArgumentCheck(String name, T value) {
            this.check = null;
            this.name = name;
            this.value = value;
        }

        
Fail the argument with the given message.
Params:
message – The message
Throws:
IllegalArgumentException – Thrown with the given message if the check fails/**
         * Fail the argument with the given message.
         *
         * @param message The message
         * @throws IllegalArgumentException Thrown with the given message if the check fails
         */
        public void orElseFail(String message) {
            if (check != null && !check.condition()) {
                throw new IllegalArgumentException(message);
            }
        }

        
Fail the argument with the given message.
Throws:
NullPointerException – Thrown with the given message if the check fails/**
         * Fail the argument with the given message.
         *
         * @throws NullPointerException Thrown with the given message if the check fails
         */
        public void notNull() {
            if (value == null) {
                throw new NullPointerException("Argument [" + name + "] cannot be null");
            }
        }
    }

    
Functional interface the check a condition.
/**
     * Functional interface the check a condition.
     */
    @FunctionalInterface
    public interface Check {

        
Returns:
Whether the condition is true/**
         * @return Whether the condition is true
         */
        boolean condition();
    }
}