org.apache.wicket.util.lang.Checks.java Source code

Introduction

Here is the source code for org.apache.wicket.util.lang.Checks.java

Source

/*
 * 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.wicket.util.lang;

import org.apache.wicket.util.string.Strings;

/**
 * 
 */
public class Checks {
    /**
     * Checks value is not null
     * 
     * @param argument
     * @param message
     * @param params
     * @throws IllegalStateException
     */
    public static void notNull(final Object argument, final String message, final Object... params) {
        if (argument == null) {
            throw new IllegalStateException(Args.format(message, params));
        }
    }

    /**
     * Checks argument is not empty (not null and has a non-whitespace character)
     * 
     * @param argument
     * @param message
     * @param params
     * @throws IllegalStateException
     */
    public static void notEmpty(final String argument, final String message, final Object... params) {
        if (Strings.isEmpty(argument)) {
            throw new IllegalStateException(Args.format(message, params));
        }
    }

    /**
     * Checks if argument is within a range
     * 
     * @param <T>
     * @param min
     * @param max
     * @param value
     * @param message
     * @throws IllegalStateException
     */
    public static <T extends Comparable<? super T>> void withinRange(final T min, final T max, final T value,
            final String message) {
        notNull(min, message);
        notNull(max, message);

        if ((value.compareTo(min) < 0) || (value.compareTo(max) > 0)) {
            throw new IllegalStateException(message);
        }
    }

    /**
     * Checks value is not null
     * 
     * @param argument
     * @param name
     * @throws IllegalStateException
     */
    public static void notNullShort(final Object argument, final String name) {
        notNull(argument, name + " may not be null.");
    }

    /**
     * Checks argument is not empty (not null and has a non-whitespace character)
     * 
     * @param argument
     * @param name
     * @throws IllegalStateException
     */
    public static void notEmptyShort(final String argument, final String name) {
        notEmpty(argument, name + " may not be null or empty string.");
    }

    /**
     * Checks if argument is within a range
     * 
     * @param <T>
     * @param min
     * @param max
     * @param value
     * @param name
     * @throws IllegalStateException
     */
    public static <T extends Comparable<? super T>> void withinRangeShort(final T min, final T max, final T value,
            final String name) {
        withinRange(min, max, value,
                String.format("%s must have a value within [%s,%s], but was %s", name, min, max, value));
    }
}