ParametersChecker.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/
package fr.gouv.vitam.common;

import com.google.common.base.Strings;

/**
 * Checker for Parameters <br>
 * <br>
 * Can be used for String (testing also emptiness) and for general Object.<br>
 * For null String only, use the special method.
 *
 *
 */
public final class ParametersChecker {

    private ParametersChecker() {
        // empty
    }
    
    private static final String MANDATORY_PARAMETER = " is mandatory parameter";

    /**
     * Check if any parameter are null or empty and if so, throw an IllegalArgumentException
     *
     * @param errorMessage the error message
     * @param parameters parameters to be checked
     * @throws IllegalArgumentException if null or empty
     */
    public static final void checkParameter(String errorMessage, String... parameters) {
        if (parameters == null) {
            throw new IllegalArgumentException(errorMessage);
        }
        for (final String parameter : parameters) {
            if (Strings.isNullOrEmpty(parameter) || parameter.trim().isEmpty()) {
                throw new IllegalArgumentException(errorMessage);
            }
        }
    }
    
    /**
     * Check if any parameter are null or empty and if so, throw an IllegalArgumentException
     *
     * @param errorMessage the error message
     * @param parameters
     * @throws IllegalArgumentException if null or empty
     */
    public static final void checkParameterDefault(String errorMessage, String... parameters) {
        if (parameters == null) {
            throw new IllegalArgumentException(errorMessage + MANDATORY_PARAMETER);
        }
        for (final String parameter : parameters) {
            if (Strings.isNullOrEmpty(parameter) || parameter.trim().isEmpty()) {
                throw new IllegalArgumentException(errorMessage + MANDATORY_PARAMETER);
            }
        }
    }
    
    /**
     * Check if any parameter are null or empty and if so, throw an IllegalArgumentException
     *
     * @param errorMessage
     * @param parameters
     * @throws IllegalArgumentException if null or empty
     */
    public static final void checkParameterDefault(String errorMessage, Object... parameters) {
        if (parameters == null) {
            throw new IllegalArgumentException(errorMessage + MANDATORY_PARAMETER);
        }
        for (final Object parameter : parameters) {
            if (parameter == null) {
                throw new IllegalArgumentException(errorMessage + MANDATORY_PARAMETER);
            }
        }
    }

    /**
     * Check if any parameter are null and if so, throw an IllegalArgumentException
     *
     * @param errorMessage the error message
     * @param parameters parameters to be checked
     * @throws IllegalArgumentException if null
     */
    public static final void checkParameterNullOnly(String errorMessage, String... parameters) {
        if (parameters == null) {
            throw new IllegalArgumentException(errorMessage);
        }
        for (final String parameter : parameters) {
            if (parameter == null) {
                throw new IllegalArgumentException(errorMessage);
            }
        }
    }

    /**
     * Check if any parameter are null and if so, throw an IllegalArgumentException
     *
     * @param errorMessage
     * @param parameters parameters to be checked
     * @throws IllegalArgumentException if null
     */
    public static final void checkParameter(String errorMessage, Object... parameters) {
        if (parameters == null) {
            throw new IllegalArgumentException(errorMessage);
        }
        for (final Object parameter : parameters) {
            if (parameter == null) {
                throw new IllegalArgumentException(errorMessage);
            }
        }
    }

    /**
     * Check if an integer parameter is greater or equals to minValue
     *
     * @param name name of the variable
     * @param variable
     * @param minValue
     */
    public static final void checkValue(String name, long variable, long minValue) {
        if (variable < minValue) {
            throw new IllegalArgumentException("Parameter " + name + " is less than " + minValue);
        }
    }
}