io.proximax.core.utils.MustBe Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-xpx-chain-sdk Show documentation
The ProximaX Sirius Chain Java SDK is a Java library for interacting with the Sirius Blockchain.
The newest version!
/*
 * Copyright 2018 NEM
 *
 * 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.proximax.core.utils;

import java.util.Collection;
import java.util.regex.Pattern;

/**
 * Helper class for validating parameters.
 */
public class MustBe {

    /**
     * Throws an exception if the specified object is null.
     *
     * @param obj  The object.
     * @param name The object name.
     */
    public static void notNull(final Object obj, final String name) {
        if (null == obj) {
            final String message = String.format("%s cannot be null", name);
            throw new IllegalArgumentException(message);
        }
    }

    /**
     * Throws an exception if the specified string contains no non-whitespace characters.
     *
     * @param str       The string.
     * @param name      The string name.
     * @param maxLength The max length.
     */
    public static void notWhitespace(final String str, final String name, final int maxLength) {
        if (StringUtils.isNullOrWhitespace(str) || str.length() > maxLength) {
            final String message = String.format("%s cannot be null, empty, or whitespace, or have length greater than %d", name, maxLength);
            throw new IllegalArgumentException(message);
        }
    }

    /**
     * Throws an exception if the specified string does not match the pattern, is empty, or longer than the max length.
     *
     * @param str       The string.
     * @param name      The string name.
     * @param pattern   The pattern to match.
     * @param maxLength The max length.
     */
    public static void match(final String str, final String name, final Pattern pattern, final int maxLength) {
        if (null == str || str.isEmpty() || str.length() > maxLength || !pattern.matcher(str).matches()) {
            final String message = String.format("%s does not match the desired pattern", name);
            throw new IllegalArgumentException(message);
        }
    }

    /**
     * Throws an exception if the specified integer value is not in the specified inclusive range.
     *
     * @param value        The integer value.
     * @param name         The value name.
     * @param minInclusive The min allowed value (inclusive).
     * @param maxInclusive The max allowed value (inclusive).
     */
    public static void inRange(final int value, final String name, final int minInclusive, final int maxInclusive) {
        inRange((long) value, name, minInclusive, maxInclusive);
    }

    /**
     * Throws an exception if the specified long value is not in the specified inclusive range.
     *
     * @param value        The long value.
     * @param name         The value name.
     * @param minInclusive The min allowed value (inclusive).
     * @param maxInclusive The max allowed value (inclusive).
     */
    public static void inRange(final long value, final String name, final long minInclusive, final long maxInclusive) {
        if (value < minInclusive || value > maxInclusive) {
            final String message = String.format("%s must be between %d and %d inclusive", name, minInclusive, maxInclusive);
            throw new IllegalArgumentException(message);
        }
    }

    /**
     * Throws an exception if the specified collection is not empty.
     *
     * @param collection The collection.
     * @param name       The collection name.
     */
    public static void empty(final Collection collection, final String name) {
        if (!collection.isEmpty()) {
            final String message = String.format("%s must be empty", name);
            throw new IllegalArgumentException(message);
        }
    }

    /**
     * Throws an exception if the specified value is not true.
     *
     * @param value The value.
     * @param name  The value name.
     */
    public static void trueValue(final boolean value, final String name) {
        if (!value) {
            final String message = String.format("%s must be true", name);
            throw new IllegalArgumentException(message);
        }
    }

    /**
     * Throws an exception if the specified value is not false.
     *
     * @param value The value.
     * @param name  The value name.
     */
    public static void falseValue(final boolean value, final String name) {
        if (value) {
            final String message = String.format("%s must be false", name);
            throw new IllegalArgumentException(message);
        }
    }
}