com.feilong.lib.lang3.Validate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
/*
 * 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 com.feilong.lib.lang3;

import java.util.Objects;

/**
 * 
 * This class assists in validating arguments. The validation methods are
 * based along the following principles:
 * 

 * An invalid {@code null} argument causes a {@link NullPointerException}.
 * A non-{@code null} argument causes an {@link IllegalArgumentException}.
 * An invalid index into an array/collection/map/string causes an {@link IndexOutOfBoundsException}.
 * 
 *
 * 
 * All exceptions messages are
 * format strings
 * as defined by the Java platform. For example:
 * 
 *
 *  * Validate.isTrue(i > 0, "The value must be greater than zero: %d", i);
 * Validate.notNull(surname, "The surname must not be %s", null);
 * 
 *
 * 
 * #ThreadSafe#
 * 
 * 
 * @see java.lang.String#format(String, Object...)
 * @since 2.0
 * @deprecated pls use com.feilong.core.Validate
 */
@Deprecated
public class Validate{

    /**
     * 
     * Validate that the argument condition is {@code true}; otherwise
     * throwing an exception with the specified message. This method is useful when
     * validating according to an arbitrary boolean expression, such as validating a
     * primitive number or using your own custom validation expression.
     * 
     *
     *      * Validate.isTrue(i >= min && i <= max, "The value must be between %d and %d", min, max);
     * Validate.isTrue(myObject.isOk(), "The object is not okay");
     * 
     *
     * @param expression
     *            the boolean expression to check
     * @param message
     *            the {@link String#format(String, Object...)} exception message if invalid, not null
     * @param values
     *            the optional values for the formatted exception message, null array not recommended
     * @throws IllegalArgumentException
     *             if expression is {@code false}
     */
    public static void isTrue(final boolean expression,final String message,final Object...values){
        if (!expression){
            throw new IllegalArgumentException(String.format(message, values));
        }
    }

    /**
     * 
     * Validate that the specified argument is not {@code null};
     * otherwise throwing an exception with the specified message.
     *
     * 
     * Validate.notNull(myObject, "The object must not be null");
     * 
     *
     * @param 
     *            the object type
     * @param object
     *            the object to check
     * @param message
     *            the {@link String#format(String, Object...)} exception message if invalid, not null
     * @param values
     *            the optional values for the formatted exception message
     * @return the validated object (never {@code null} for method chaining)
     * @throws NullPointerException
     *             if the object is {@code null}
     */
    public static  T notNull(final T object,final String message,final Object...values){
        return Objects.requireNonNull(object, () -> String.format(message, values));
    }

}