io.rxmicro.common.util.Requires Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxmicro-common Show documentation
The common module with base models and useful utils.
There is a newer version: 0.11
/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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.rxmicro.common.util;

import static io.rxmicro.common.util.Formats.format;

/**
 * Custom require utils.
 *
 * @author nedis
 * @since 0.1
 */
public final class Requires {

    /**
     * Checks that the specified object reference is not {@code null}.
     *
     * 
     * The main advantage of this method comparing with {@link java.util.Objects#requireNonNull(Object)} is the ability to replace
     * {@code if} statement by the {@code assert} one.
     * This replacement can increase the performance of the RxMicro framework.
     *
     * @param instance the specified object
     * @param  the type of the reference
     * @return {@code obj} if not {@code null}
     * @see java.util.Objects#requireNonNull(Object)
     * @throws NullPointerException if the specified object is {@code null}
     */
    public static  T require(final T instance) {
        //assert instance != null;
        if (instance == null) {
            throw new NullPointerException();
        }
        return instance;
    }

    /**
     * Checks that the specified object reference is not {@code null} and throws a exception with custom message if it is.
     *
     * 
     * The main advantage of this method comparing with {@link java.util.Objects#requireNonNull(Object, String)} is the ability to replace
     * {@code if} statement by the {@code assert} one.
     * This replacement can increase the performance of the RxMicro framework.
     *
     * @param instance the specified object
     * @param message the message template
     * @param args the message template arguments
     * @param  the type of the reference
     * @return {@code obj} if not {@code null}
     * @see java.util.Objects#requireNonNull(Object, String)
     * @throws NullPointerException if the message template is {@code null} or the specified object is {@code null}
     * @throws IllegalArgumentException if detected a redundant placeholder or missing argument
     */
    public static  T require(final T instance,
                                final String message,
                                final Object... args) {
        //assert instance != null : format(message, args);
        if (instance == null) {
            throw new NullPointerException(format(message, args));
        }
        return instance;
    }

    private Requires() {
    }
}