com.dahuatech.hutool.core.lang.Assert Maven / Gradle / Ivy

Go to download
package com.dahuatech.hutool.core.lang;

import com.dahuatech.hutool.core.collection.CollectionUtil;
import com.dahuatech.hutool.core.util.ArrayUtil;
import com.dahuatech.hutool.core.util.StrUtil;

import java.util.Collection;
import java.util.Map;

/**
 * 断言

 * 断言某些对象或值是否符合规定，否则抛出异常。经常用于做变量检查
 *
 * @author Looly
 */
public class Assert {

  /**
   * 断言是否为真，如果为 {@code false} 抛出 {@code IllegalArgumentException} 异常

   *
   *    * Assert.isTrue(i > 0, "The value must be greater than zero");
   * 
   *
   * @param expression 波尔值
   * @param errorMsgTemplate 错误抛出异常附带的消息模板，变量用{}代替
   * @param params 参数列表
   * @throws IllegalArgumentException if expression is {@code false}
   */
  public static void isTrue(boolean expression, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (false == expression) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
  }

  /**
   * 断言是否为真，如果为 {@code false} 抛出 {@code IllegalArgumentException} 异常

   *
   *    * Assert.isTrue(i > 0, "The value must be greater than zero");
   * 
   *
   * @param expression 波尔值
   * @throws IllegalArgumentException if expression is {@code false}
   */
  public static void isTrue(boolean expression) throws IllegalArgumentException {
    isTrue(expression, "[Assertion failed] - this expression must be true");
  }

  /**
   * 断言是否为假，如果为 {@code true} 抛出 {@code IllegalArgumentException} 异常

   *
   *    * Assert.isFalse(i < 0, "The value must be greater than zero");
   * 
   *
   * @param expression 波尔值
   * @param errorMsgTemplate 错误抛出异常附带的消息模板，变量用{}代替
   * @param params 参数列表
   * @throws IllegalArgumentException if expression is {@code false}
   */
  public static void isFalse(boolean expression, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (expression) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
  }

  /**
   * 断言是否为假，如果为 {@code true} 抛出 {@code IllegalArgumentException} 异常

   *
   *    * Assert.isFalse(i < 0);
   * 
   *
   * @param expression 波尔值
   * @throws IllegalArgumentException if expression is {@code false}
   */
  public static void isFalse(boolean expression) throws IllegalArgumentException {
    isFalse(expression, "[Assertion failed] - this expression must be false");
  }

  /**
   * 断言对象是否为{@code null} ，如果不为{@code null} 抛出{@link IllegalArgumentException} 异常
   *
   *    * Assert.isNull(value, "The value must be null");
   * 
   *
   * @param object 被检查的对象
   * @param errorMsgTemplate 消息模板，变量使用{}表示
   * @param params 参数列表
   * @throws IllegalArgumentException if the object is not {@code null}
   */
  public static void isNull(Object object, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (object != null) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
  }

  /**
   * 断言对象是否为{@code null} ，如果不为{@code null} 抛出{@link IllegalArgumentException} 异常
   *
   *    * Assert.isNull(value);
   * 
   *
   * @param object 被检查对象
   * @throws IllegalArgumentException if the object is not {@code null}
   */
  public static void isNull(Object object) throws IllegalArgumentException {
    isNull(object, "[Assertion failed] - the object argument must be null");
  }

  // ----------------------------------------------------------------------------------------------------------- Check not null
  /**
   * 断言对象是否不为{@code null} ，如果为{@code null} 抛出{@link IllegalArgumentException} 异常 Assert that an
   * object is not {@code null} .
   *
   *    * Assert.notNull(clazz, "The class must not be null");
   * 
   *
   * @param  被检查对象泛型类型
   * @param object 被检查对象
   * @param errorMsgTemplate 错误消息模板，变量使用{}表示
   * @param params 参数
   * @return 被检查后的对象
   * @throws IllegalArgumentException if the object is {@code null}
   */
  public static  T notNull(T object, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (object == null) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return object;
  }

  /**
   * 断言对象是否不为{@code null} ，如果为{@code null} 抛出{@link IllegalArgumentException} 异常
   *
   *    * Assert.notNull(clazz);
   * 
   *
   * @param  被检查对象类型
   * @param object 被检查对象
   * @return 非空对象
   * @throws IllegalArgumentException if the object is {@code null}
   */
  public static  T notNull(T object) throws IllegalArgumentException {
    return notNull(object, "[Assertion failed] - this argument is required; it must not be null");
  }

  // ----------------------------------------------------------------------------------------------------------- Check empty
  /**
   * 检查给定字符串是否为空，为空抛出 {@link IllegalArgumentException}
   *
   *    * Assert.notEmpty(name, "Name must not be empty");
   * 
   *
   * @param text 被检查字符串
   * @param errorMsgTemplate 错误消息模板，变量使用{}表示
   * @param params 参数
   * @return 非空字符串
   * @see StrUtil#isNotEmpty(CharSequence)
   * @throws IllegalArgumentException 被检查字符串为空
   */
  public static String notEmpty(String text, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (StrUtil.isEmpty(text)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return text;
  }

  /**
   * 检查给定字符串是否为空，为空抛出 {@link IllegalArgumentException}
   *
   *    * Assert.notEmpty(name);
   * 
   *
   * @param text 被检查字符串
   * @return 被检查的字符串
   * @see StrUtil#isNotEmpty(CharSequence)
   * @throws IllegalArgumentException 被检查字符串为空
   */
  public static String notEmpty(String text) throws IllegalArgumentException {
    return notEmpty(
        text,
        "[Assertion failed] - this String argument must have length; it must not be null or empty");
  }

  /**
   * 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 {@link IllegalArgumentException}
   *
   *    * Assert.notBlank(name, "Name must not be blank");
   * 
   *
   * @param text 被检查字符串
   * @param errorMsgTemplate 错误消息模板，变量使用{}表示
   * @param params 参数
   * @return 非空字符串
   * @see StrUtil#isNotBlank(CharSequence)
   * @throws IllegalArgumentException 被检查字符串为空白
   */
  public static String notBlank(String text, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (StrUtil.isBlank(text)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return text;
  }

  /**
   * 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 {@link IllegalArgumentException}
   *
   *    * Assert.notBlank(name, "Name must not be blank");
   * 
   *
   * @param text 被检查字符串
   * @return 非空字符串
   * @see StrUtil#isNotBlank(CharSequence)
   * @throws IllegalArgumentException 被检查字符串为空白
   */
  public static String notBlank(String text) throws IllegalArgumentException {
    return notBlank(
        text,
        "[Assertion failed] - this String argument must have text; it must not be null, empty, or blank");
  }

  /**
   * 断言给定字符串是否不被另一个字符串包含（即是否为子串）
   *
   *    * Assert.doesNotContain(name, "rod", "Name must not contain 'rod'");
   * 
   *
   * @param textToSearch 被搜索的字符串
   * @param substring 被检查的子串
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 被检查的子串
   * @throws IllegalArgumentException 非子串抛出异常
   */
  public static String notContain(
      String textToSearch, String substring, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (StrUtil.isNotEmpty(textToSearch)
        && StrUtil.isNotEmpty(substring)
        && textToSearch.contains(substring)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return substring;
  }

  /**
   * 断言给定字符串是否不被另一个字符串包含（即是否为子串）
   *
   *    * Assert.doesNotContain(name, "rod", "Name must not contain 'rod'");
   * 
   *
   * @param textToSearch 被搜索的字符串
   * @param substring 被检查的子串
   * @return 被检查的子串
   * @throws IllegalArgumentException 非子串抛出异常
   */
  public static String notContain(String textToSearch, String substring)
      throws IllegalArgumentException {
    return notContain(
        textToSearch,
        substring,
        "[Assertion failed] - this String argument must not contain the substring [{}]",
        substring);
  }

  /**
   * 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素
   *
   *    * Assert.notEmpty(array, "The array must have elements");
   * 
   *
   * @param array 被检查的数组
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 被检查的数组
   * @throws IllegalArgumentException if the object array is {@code null} or has no elements
   */
  public static Object[] notEmpty(Object[] array, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (ArrayUtil.isEmpty(array)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return array;
  }

  /**
   * 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素
   *
   *    * Assert.notEmpty(array, "The array must have elements");
   * 
   *
   * @param array 被检查的数组
   * @return 被检查的数组
   * @throws IllegalArgumentException if the object array is {@code null} or has no elements
   */
  public static Object[] notEmpty(Object[] array) throws IllegalArgumentException {
    return notEmpty(
        array,
        "[Assertion failed] - this array must not be empty: it must contain at least 1 element");
  }

  /**
   * 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含
   *
   *    * Assert.noNullElements(array, "The array must have non-null elements");
   * 
   *
   * @param  数组元素类型
   * @param array 被检查的数组
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 被检查的数组
   * @throws IllegalArgumentException if the object array contains a {@code null} element
   */
  public static  T[] noNullElements(T[] array, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (ArrayUtil.hasNull(array)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return array;
  }

  /**
   * 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含
   *
   *    * Assert.noNullElements(array);
   * 
   *
   * @param  数组元素类型
   * @param array 被检查的数组
   * @return 被检查的数组
   * @throws IllegalArgumentException if the object array contains a {@code null} element
   */
  public static  T[] noNullElements(T[] array) throws IllegalArgumentException {
    return noNullElements(
        array, "[Assertion failed] - this array must not contain any null elements");
  }

  /**
   * 断言给定集合非空
   *
   *    * Assert.notEmpty(collection, "Collection must have elements");
   * 
   *
   * @param  集合元素类型
   * @param collection 被检查的集合
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 非空集合
   * @throws IllegalArgumentException if the collection is {@code null} or has no elements
   */
  public static  Collection notEmpty(
      Collection collection, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (CollectionUtil.isEmpty(collection)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return collection;
  }

  /**
   * 断言给定集合非空
   *
   *    * Assert.notEmpty(collection);
   * 
   *
   * @param  集合元素类型
   * @param collection 被检查的集合
   * @return 被检查集合
   * @throws IllegalArgumentException if the collection is {@code null} or has no elements
   */
  public static  Collection notEmpty(Collection collection)
      throws IllegalArgumentException {
    return notEmpty(
        collection,
        "[Assertion failed] - this collection must not be empty: it must contain at least 1 element");
  }

  /**
   * 断言给定Map非空
   *
   *    * Assert.notEmpty(map, "Map must have entries");
   * 
   *
   * @param  Key类型
   * @param  Value类型
   * @param map 被检查的Map
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 被检查的Map
   * @throws IllegalArgumentException if the map is {@code null} or has no entries
   */
  public static  Map notEmpty(Map map, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    if (CollectionUtil.isEmpty(map)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return map;
  }

  /**
   * 断言给定Map非空
   *
   *    * Assert.notEmpty(map, "Map must have entries");
   * 
   *
   * @param  Key类型
   * @param  Value类型
   * @param map 被检查的Map
   * @return 被检查的Map
   * @throws IllegalArgumentException if the map is {@code null} or has no entries
   */
  public static  Map notEmpty(Map map) throws IllegalArgumentException {
    return notEmpty(
        map, "[Assertion failed] - this map must not be empty; it must contain at least one entry");
  }

  /**
   * 断言给定对象是否是给定类的实例
   *
   *    * Assert.instanceOf(Foo.class, foo);
   * 
   *
   * @param  被检查对象泛型类型
   * @param type 被检查对象匹配的类型
   * @param obj 被检查对象
   * @return 被检查的对象
   * @throws IllegalArgumentException if the object is not an instance of clazz
   * @see Class#isInstance(Object)
   */
  public static  T isInstanceOf(Class type, T obj) {
    return isInstanceOf(type, obj, "Object [{}] is not instanceof [{}]", obj, type);
  }

  /**
   * 断言给定对象是否是给定类的实例
   *
   *    * Assert.instanceOf(Foo.class, foo);
   * 
   *
   * @param  被检查对象泛型类型
   * @param type 被检查对象匹配的类型
   * @param obj 被检查对象
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 被检查对象
   * @throws IllegalArgumentException if the object is not an instance of clazz
   * @see Class#isInstance(Object)
   */
  public static  T isInstanceOf(Class type, T obj, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    notNull(type, "Type to check against must not be null");
    if (false == type.isInstance(obj)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
    return obj;
  }

  /**
   * 断言 {@code superType.isAssignableFrom(subType)} 是否为 {@code true}.
   *
   *    * Assert.isAssignable(Number.class, myClass);
   * 
   *
   * @param superType 需要检查的父类或接口
   * @param subType 需要检查的子类
   * @throws IllegalArgumentException 如果子类非继承父类，抛出此异常
   */
  public static void isAssignable(Class superType, Class subType)
      throws IllegalArgumentException {
    isAssignable(superType, subType, "{} is not assignable to {})", subType, superType);
  }

  /**
   * 断言 {@code superType.isAssignableFrom(subType)} 是否为 {@code true}.
   *
   *    * Assert.isAssignable(Number.class, myClass);
   * 
   *
   * @param superType 需要检查的父类或接口
   * @param subType 需要检查的子类
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @throws IllegalArgumentException 如果子类非继承父类，抛出此异常
   */
  public static void isAssignable(
      Class superType, Class subType, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException {
    notNull(superType, "Type to check against must not be null");
    if (subType == null || !superType.isAssignableFrom(subType)) {
      throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params));
    }
  }

  /**
   * 检查boolean表达式，当检查结果为false时抛出 {@code IllegalStateException}。
   *
   *    * Assert.state(id == null, "The id property must not already be initialized");
   * 
   *
   * @param expression boolean 表达式
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @throws IllegalStateException 表达式为 {@code false} 抛出此异常
   */
  public static void state(boolean expression, String errorMsgTemplate, Object... params)
      throws IllegalStateException {
    if (false == expression) {
      throw new IllegalStateException(StrUtil.format(errorMsgTemplate, params));
    }
  }

  /**
   * 检查boolean表达式，当检查结果为false时抛出 {@code IllegalStateException}。
   *
   *    * Assert.state(id == null);
   * 
   *
   * @param expression boolean 表达式
   * @throws IllegalStateException 表达式为 {@code false} 抛出此异常
   */
  public static void state(boolean expression) throws IllegalStateException {
    state(expression, "[Assertion failed] - this state invariant must be true");
  }

  /**
   * 检查下标（数组、集合、字符串）是否符合要求，下标必须满足：
   *
   *    * 0 ≤ index < size
   * 
   *
   * @param index 下标
   * @param size 长度
   * @return 检查后的下标
   * @throws IllegalArgumentException 如果size < 0 抛出此异常
   * @throws IndexOutOfBoundsException 如果index < 0或者 index ≥ size 抛出此异常
   * @since 4.1.9
   */
  public static int checkIndex(int index, int size)
      throws IllegalArgumentException, IndexOutOfBoundsException {
    return checkIndex(index, size, "[Assertion failed]");
  }

  /**
   * 检查下标（数组、集合、字符串）是否符合要求，下标必须满足：
   *
   *    * 0 ≤ index < size
   * 
   *
   * @param index 下标
   * @param size 长度
   * @param errorMsgTemplate 异常时的消息模板
   * @param params 参数列表
   * @return 检查后的下标
   * @throws IllegalArgumentException 如果size < 0 抛出此异常
   * @throws IndexOutOfBoundsException 如果index < 0或者 index ≥ size 抛出此异常
   * @since 4.1.9
   */
  public static int checkIndex(int index, int size, String errorMsgTemplate, Object... params)
      throws IllegalArgumentException, IndexOutOfBoundsException {
    if (index < 0 || index >= size) {
      throw new IndexOutOfBoundsException(badIndexMsg(index, size, errorMsgTemplate, params));
    }
    return index;
  }

  /**
   * 检查值是否在指定范围内
   *
   * @param value 值
   * @param min 最小值（包含）
   * @param max 最大值（包含）
   * @return 检查后的长度值
   * @since 4.1.10
   */
  public static int checkBetween(int value, int min, int max) {
    if (value < min || value > max) {
      throw new IllegalArgumentException(
          StrUtil.format("Length must be between {} and {}.", min, max));
    }
    return value;
  }

  /**
   * 检查值是否在指定范围内
   *
   * @param value 值
   * @param min 最小值（包含）
   * @param max 最大值（包含）
   * @return 检查后的长度值
   * @since 4.1.10
   */
  public static long checkBetween(long value, long min, long max) {
    if (value < min || value > max) {
      throw new IllegalArgumentException(
          StrUtil.format("Length must be between {} and {}.", min, max));
    }
    return value;
  }

  /**
   * 检查值是否在指定范围内
   *
   * @param value 值
   * @param min 最小值（包含）
   * @param max 最大值（包含）
   * @return 检查后的长度值
   * @since 4.1.10
   */
  public static double checkBetween(double value, double min, double max) {
    if (value < min || value > max) {
      throw new IllegalArgumentException(
          StrUtil.format("Length must be between {} and {}.", min, max));
    }
    return value;
  }

  /**
   * 检查值是否在指定范围内
   *
   * @param value 值
   * @param min 最小值（包含）
   * @param max 最大值（包含）
   * @return 检查后的长度值
   * @since 4.1.10
   */
  public static Number checkBetween(Number value, Number min, Number max) {
    notNull(value);
    notNull(min);
    notNull(max);
    double valueDouble = value.doubleValue();
    double minDouble = min.doubleValue();
    double maxDouble = max.doubleValue();
    if (valueDouble < minDouble || valueDouble > maxDouble) {
      throw new IllegalArgumentException(
          StrUtil.format("Length must be between {} and {}.", min, max));
    }
    return value;
  }

  // -------------------------------------------------------------------------------------------------------------------------------------------- Private method start
  /**
   * 错误的下标时显示的消息
   *
   * @param index 下标
   * @param size 长度
   * @param desc 异常时的消息模板
   * @param params 参数列表
   * @return 消息
   */
  private static String badIndexMsg(int index, int size, String desc, Object... params) {
    if (index < 0) {
      return StrUtil.format("{} ({}) must not be negative", StrUtil.format(desc, params), index);
    } else if (size < 0) {
      throw new IllegalArgumentException("negative size: " + size);
    } else { // index >= size
      return StrUtil.format(
          "{} ({}) must be less than size ({})", StrUtil.format(desc, params), index, size);
    }
  }
  // -------------------------------------------------------------------------------------------------------------------------------------------- Private method end
}