org.apache.logging.log4j.core.util.Assert Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of log4j-core Show documentation

The Apache Log4j Implementation

There is a newer version: 3.0.0-beta2

/*
 * 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 org.apache.logging.log4j.core.util;

import java.util.Objects;

/**
 * Utility class providing common validation logic.
 */
public final class Assert {
    private Assert() {
    }

    public static int valueIsAtLeast(final int value, final int minValue) {
        if (value < minValue) {
            throw new IllegalArgumentException("Value should be at least " + minValue + " but was " + value);
        }
        return value;
    }

    /**
     * Throws a {@code NullPointerException} if the specified parameter is
     * {@code null}, otherwise returns the specified parameter.
     * 
     * On Java 7, just use {@code Objects.requireNonNull(T, String)}
     * 
     * 
     * Usage:
     * 
     *      * // earlier you would write this:
     * public SomeConstructor(Object param) {
     *     if (param == null) {
     *         throw new NullPointerException("param");
     *     }
     *     this.field = param;
     * }
     *
     * // now you can do the same in one line:
     * public SomeConstructor(Object param) {
     *     this.field = Assert.requireNonNull("param");
     * }
     * 
     *
     * @param  the type of the parameter to check and return
     * @param object the parameter to check
     * @param message message to populate the NPE with if necessary
     * @return the specified parameter
     * @throws NullPointerException if {@code object} is {@code null}
     * @deprecated Will be removed in 2.5.
     */
    @Deprecated
    public static  T requireNonNull(final T object, final String message) {
        return Objects.requireNonNull(object, message);
    }
}