クラス Assert

メソッドの詳細

• state

  @Contract("false, _ -> fail") public static void state(boolean expression, StringSE message)

  ブール式をアサートし、式が false と評価された場合は IllegalStateException をスローします。

  アサーションの失敗時に IllegalArgumentException をスローする場合は、isTrue(boolean, java.lang.String) を呼び出します。

  Assert.state(id == null, "The id property must not already be initialized");

  パラメーター:

  expression - ブール式

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalStateExceptionSE - expression が false の場合

• state

  @Contract("false, _ -> fail") public static void state(boolean expression, SupplierSE<StringSE> messageSupplier)

  ブール式をアサートし、式が false と評価された場合は IllegalStateException をスローします。

  アサーションの失敗時に IllegalArgumentException をスローする場合は、isTrue(boolean, java.lang.String) を呼び出します。

   Assert.state(entity.getId() == null,
       () -> "ID for entity " + entity.getName() + " must not already be initialized");
   

  パラメーター:

  expression - ブール式

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalStateExceptionSE - expression が false の場合

  導入:

  5.0

• isTrue

  @Contract("false, _ -> fail") public static void isTrue(boolean expression, StringSE message)

  ブール式をアサートし、式が false と評価された場合は IllegalArgumentException をスローします。

  Assert.isTrue(i > 0, "The value must be greater than zero");

  パラメーター:

  expression - ブール式

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - expression が false の場合

• isTrue

  @Contract("false, _ -> fail") public static void isTrue(boolean expression, SupplierSE<StringSE> messageSupplier)

  ブール式をアサートし、式が false と評価された場合は IllegalArgumentException をスローします。

   Assert.isTrue(i > 0, () -> "The value '" + i + "' must be greater than zero");
   

  パラメーター:

  expression - ブール式

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - expression が false の場合

  導入:

  5.0

• isNull

  @Contract("!null, _ -> fail") public static void isNull(@Nullable ObjectSE object, StringSE message)

  オブジェクトが null であることを表明します。

  Assert.isNull(value, "The value must be null");

  パラメーター:

  object - チェックするオブジェクト

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - オブジェクトが null でない場合

• isNull

  @Contract("!null, _ -> fail") public static void isNull(@Nullable ObjectSE object, SupplierSE<StringSE> messageSupplier)

  オブジェクトが null であることを表明します。

   Assert.isNull(value, () -> "The value '" + value + "' must be null");
   

  パラメーター:

  object - チェックするオブジェクト

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - オブジェクトが null でない場合

  導入:

  5.0

• notNull

  @Contract("null, _ -> fail") public static void notNull(@Nullable ObjectSE object, StringSE message)

  オブジェクトが null ではないことを表明します。

  Assert.notNull(clazz, "The class must not be null");

  パラメーター:

  object - チェックするオブジェクト

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - オブジェクトが null の場合

• notNull

  @Contract("null, _ -> fail") public static void notNull(@Nullable ObjectSE object, SupplierSE<StringSE> messageSupplier)

  オブジェクトが null ではないことを表明します。

   Assert.notNull(entity.getId(),
       () -> "ID for entity " + entity.getName() + " must not be null");
   

  パラメーター:

  object - チェックするオブジェクト

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - オブジェクトが null の場合

  導入:

  5.0

• hasLength

  @Contract("null, _ -> fail") public static void hasLength(@Nullable StringSE text, StringSE message)

  指定された文字列が空でないことを表明します。つまり、null であってはならず、空の文字列であってはなりません。

  Assert.hasLength(name, "Name must not be empty");

  パラメーター:

  text - チェックする文字列

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - テキストが空の場合

  関連事項:

  • StringUtils.hasLength(java.lang.CharSequence)

• hasLength

  @Contract("null, _ -> fail") public static void hasLength(@Nullable StringSE text, SupplierSE<StringSE> messageSupplier)

  指定された文字列が空でないことを表明します。つまり、null であってはならず、空の文字列であってはなりません。

   Assert.hasLength(account.getName(),
       () -> "Name for account '" + account.getId() + "' must not be empty");
   

  パラメーター:

  text - チェックする文字列

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - テキストが空の場合

  導入:

  5.0

  関連事項:

  • StringUtils.hasLength(java.lang.CharSequence)

• hasText

  @Contract("null, _ -> fail") public static void hasText(@Nullable StringSE text, StringSE message)

  指定された文字列に有効なテキストコンテンツが含まれていることをアサートします。つまり、null であってはならず、空白文字以外の文字が少なくとも 1 つ含まれている必要があります。

  Assert.hasText(name, "'name' must not be empty");

  パラメーター:

  text - チェックする文字列

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - テキストに有効なテキストコンテンツが含まれていない場合

  関連事項:

  • StringUtils.hasText(java.lang.CharSequence)

• hasText

  @Contract("null, _ -> fail") public static void hasText(@Nullable StringSE text, SupplierSE<StringSE> messageSupplier)

  指定された文字列に有効なテキストコンテンツが含まれていることをアサートします。つまり、null であってはならず、空白文字以外の文字が少なくとも 1 つ含まれている必要があります。

   Assert.hasText(account.getName(),
       () -> "Name for account '" + account.getId() + "' must not be empty");
   

  パラメーター:

  text - チェックする文字列

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - テキストに有効なテキストコンテンツが含まれていない場合

  導入:

  5.0

  関連事項:

  • StringUtils.hasText(java.lang.CharSequence)

• doesNotContain

  public static void doesNotContain(@Nullable StringSE textToSearch, StringSE substring, StringSE message)

  指定されたテキストに指定された部分文字列が含まれていないことを表明します。

  Assert.doesNotContain(name, "rod", "Name must not contain 'rod'");

  パラメーター:

  textToSearch - 検索するテキスト

  substring - テキスト内で検索する部分文字列

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - テキストに部分文字列が含まれている場合

• doesNotContain

  public static void doesNotContain(@Nullable StringSE textToSearch, StringSE substring, SupplierSE<StringSE> messageSupplier)

  指定されたテキストに指定された部分文字列が含まれていないことを表明します。

   Assert.doesNotContain(name, forbidden, () -> "Name must not contain '" + forbidden + "'");
   

  パラメーター:

  textToSearch - 検索するテキスト

  substring - テキスト内で検索する部分文字列

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - テキストに部分文字列が含まれている場合

  導入:

  5.0

• notEmpty

  @Contract("null, _ -> fail") public static void notEmpty(@Nullable ObjectSE[] array, StringSE message)

  配列に要素が含まれていることをアサートします。つまり、null であってはならず、少なくとも 1 つの要素が含まれている必要があります。

  Assert.notEmpty(array, "The array must contain elements");

  パラメーター:

  array - チェックする配列

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - オブジェクト配列が null であるか、要素が含まれていない場合

• notEmpty

  @Contract("null, _ -> fail") public static void notEmpty(@Nullable ObjectSE[] array, SupplierSE<StringSE> messageSupplier)

  配列に要素が含まれていることをアサートします。つまり、null であってはならず、少なくとも 1 つの要素が含まれている必要があります。

   Assert.notEmpty(array, () -> "The " + arrayType + " array must contain elements");
   

  パラメーター:

  array - チェックする配列

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - オブジェクト配列が null であるか、要素が含まれていない場合

  導入:

  5.0

• noNullElements

  public static void noNullElements(@Nullable ObjectSE[] array, StringSE message)

  配列に null 要素が含まれていないことをアサートします。

  メモ: 配列が空の場合は文句を言わない！

  Assert.noNullElements(array, "The array must contain non-null elements");

  パラメーター:

  array - チェックする配列

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - オブジェクト配列に null 要素が含まれる場合

• noNullElements

  public static void noNullElements(@Nullable ObjectSE[] array, SupplierSE<StringSE> messageSupplier)

  配列に null 要素が含まれていないことをアサートします。

  メモ: 配列が空の場合は文句を言わない！

   Assert.noNullElements(array, () -> "The " + arrayType + " array must contain non-null elements");
   

  パラメーター:

  array - チェックする配列

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - オブジェクト配列に null 要素が含まれる場合

  導入:

  5.0

• notEmpty

  @Contract("null, _ -> fail") public static void notEmpty(@Nullable CollectionSE<?> collection, StringSE message)

  コレクションに要素が含まれていることを表明します。つまり、null であってはならず、少なくとも 1 つのエレメントを含んでいる必要があります。

  Assert.notEmpty(collection, "Collection must contain elements");

  パラメーター:

  collection - チェックするコレクション

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - コレクションが null であるか、要素が含まれていない場合

• notEmpty

  @Contract("null, _ -> fail") public static void notEmpty(@Nullable CollectionSE<?> collection, SupplierSE<StringSE> messageSupplier)

  コレクションに要素が含まれていることを表明します。つまり、null であってはならず、少なくとも 1 つのエレメントを含んでいる必要があります。

   Assert.notEmpty(collection, () -> "The " + collectionType + " collection must contain elements");
   

  パラメーター:

  collection - チェックするコレクション

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - コレクションが null であるか、要素が含まれていない場合

  導入:

  5.0

• noNullElements

  public static void noNullElements(@Nullable CollectionSE<?> collection, StringSE message)

  コレクションに null 要素が含まれていないことをアサートします。

  メモ: コレクションが空の場合でも文句は言いません！

  Assert.noNullElements(collection, "Collection must contain non-null elements");

  パラメーター:

  collection - チェックするコレクション

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - コレクションに null 要素が含まれている場合

  導入:

  5.2

• noNullElements

  public static void noNullElements(@Nullable CollectionSE<?> collection, SupplierSE<StringSE> messageSupplier)

  コレクションに null 要素が含まれていないことをアサートします。

  メモ: コレクションが空の場合でも文句は言いません！

   Assert.noNullElements(collection, () -> "Collection " + collectionName + " must contain non-null elements");
   

  パラメーター:

  collection - チェックするコレクション

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - コレクションに null 要素が含まれている場合

  導入:

  5.2

• notEmpty

  @Contract("null, _ -> fail") public static void notEmpty(@Nullable MapSE<?,?> map, StringSE message)

  マップにエントリが含まれていることをアサートします。つまり、null であってはならず、少なくとも 1 つのエントリが含まれている必要があります。

  Assert.notEmpty(map, "Map must contain entries");

  パラメーター:

  map - チェックするマップ

  message - アサーションが失敗した場合に使用する例外メッセージ

  例外:

  IllegalArgumentExceptionSE - マップが null であるか、エントリが含まれていない場合

• notEmpty

  @Contract("null, _ -> fail") public static void notEmpty(@Nullable MapSE<?,?> map, SupplierSE<StringSE> messageSupplier)

  マップにエントリが含まれていることをアサートします。つまり、null であってはならず、少なくとも 1 つのエントリが含まれている必要があります。

   Assert.notEmpty(map, () -> "The " + mapType + " map must contain entries");
   

  パラメーター:

  map - チェックするマップ

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー

  例外:

  IllegalArgumentExceptionSE - マップが null であるか、エントリが含まれていない場合

  導入:

  5.0

• isInstanceOf

  @Contract("_, null, _ -> fail") public static void isInstanceOf(ClassSE<?> type, @Nullable ObjectSE obj, StringSE message)

  提供されたオブジェクトが提供されたクラスのインスタンスであることを表明します。

  Assert.instanceOf(Foo.class, foo, "Foo expected");

  パラメーター:

  type - チェックする型

  obj - チェックするオブジェクト

  message - 追加のコンテキストを提供するために付加されるメッセージ。空の場合、または ":" または ";" で終わる場合または "," または "." の場合、完全な例外メッセージが追加されます。スペースで終わる場合は、問題のオブジェクトの型の名前が追加されます。それ以外の場合は、スペースを含む ":" と問題のオブジェクトの型の名前が追加されます。

  例外:

  IllegalArgumentExceptionSE - オブジェクトが型のインスタンスでない場合

• isInstanceOf

  @Contract("_, null, _ -> fail") public static void isInstanceOf(ClassSE<?> type, @Nullable ObjectSE obj, SupplierSE<StringSE> messageSupplier)

  提供されたオブジェクトが提供されたクラスのインスタンスであることを表明します。

   Assert.instanceOf(Foo.class, foo, () -> "Processing " + Foo.class.getSimpleName() + ":");
   

  パラメーター:

  type - チェックする型

  obj - チェックするオブジェクト

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー。詳細については、isInstanceOf(Class, Object, String) を参照してください。

  例外:

  IllegalArgumentExceptionSE - オブジェクトが型のインスタンスでない場合

  導入:

  5.0

• isInstanceOf

  @Contract("_, null -> fail") public static void isInstanceOf(ClassSE<?> type, @Nullable ObjectSE obj)

  提供されたオブジェクトが提供されたクラスのインスタンスであることを表明します。

  Assert.instanceOf(Foo.class, foo);

  パラメーター:

  type - チェックする型

  obj - チェックするオブジェクト

  例外:

  IllegalArgumentExceptionSE - オブジェクトが型のインスタンスでない場合

• isAssignable

  @Contract("_, null, _ -> fail") public static void isAssignable(ClassSE<?> superType, @Nullable ClassSE<?> subType, StringSE message)

  superType.isAssignableFrom(subType) が true であることを表明します。

  Assert.isAssignable(Number.class, myClass, "Number expected");

  パラメーター:

  superType - チェックするスーパー型

  subType - チェックするサブ型

  message - さらなるコンテキストを提供するために付加されるメッセージ。空であるか、":" または ";" で終わる場合または "," または "." の場合、完全な例外メッセージが追加されます。スペースで終わる場合は、問題のあるサブ型の名前が追加されます。それ以外の場合は、スペースと問題のあるサブ型の名前を含む ":" が追加されます。

  例外:

  IllegalArgumentExceptionSE - クラスが割り当て可能でない場合

• isAssignable

  @Contract("_, null, _ -> fail") public static void isAssignable(ClassSE<?> superType, @Nullable ClassSE<?> subType, SupplierSE<StringSE> messageSupplier)

  superType.isAssignableFrom(subType) が true であることを表明します。

   Assert.isAssignable(Number.class, myClass, () -> "Processing " + myAttributeName + ":");
   

  パラメーター:

  superType - チェックするスーパー型

  subType - チェックするサブ型

  messageSupplier - アサーションが失敗した場合に使用する例外メッセージのサプライヤー。詳細については、isAssignable(Class, Class, String) を参照してください。

  例外:

  IllegalArgumentExceptionSE - クラスが割り当て可能でない場合

  導入:

  5.0

• isAssignable

  @Contract("_, null -> fail") public static void isAssignable(ClassSE<?> superType, @Nullable ClassSE<?> subType)

  superType.isAssignableFrom(subType) が true であることを表明します。

  Assert.isAssignable(Number.class, myClass);

  パラメーター:

  superType - チェックするスーパー型

  subType - チェックするサブ型

  例外:

  IllegalArgumentExceptionSE - クラスが割り当て可能でない場合