パッケージ org.springframework.test.json

クラス AbstractJsonContentAssert<SELF extends AbstractJsonContentAssert<SELF>>

java.lang.ObjectSE
org.assertj.core.api.AbstractAssert<SELF,ACTUAL>
org.assertj.core.api.AbstractObjectAssert<SELF,JsonContent>
org.springframework.test.json.AbstractJsonContentAssert<SELF>
型パラメーター:
SELF - アサーションの種類
実装されたすべてのインターフェース:
org.assertj.core.api.Assert<SELF,JsonContent>、org.assertj.core.api.Descriptable<SELF>、org.assertj.core.api.ExtensionPoints<SELF,JsonContent>
既知の直属サブクラス
JsonContentAssert
public abstract class AbstractJsonContentAssert<SELF extends AbstractJsonContentAssert<SELF>> extends org.assertj.core.api.AbstractObjectAssert<SELF,JsonContent>
JSON ドキュメントに適用できる基本 AssertJ アサーション。

JSON パス式の評価と、値のさらなるアサーションのためにドキュメントの一部を抽出することをサポートします。

また、JSON コンパレータを使用して JSON ドキュメントをターゲットと比較することもサポートします。クラスが提供されている場合、クラスパスからロードされるリソースは相対的になります。デフォルトでは、リソースのロードに UTF-8 が使用されますが、withCharset(Charset) を使用してこれをオーバーライドできます。

導入:
6.2
作成者:
Stephane Nicoll, Phillip Webb, Andy Wilkinson, Diego Berrueta, Camille Vienot

  • フィールドサマリー

    クラス org.assertj.core.api.AbstractAssert から継承されたフィールド

    actual, info, myself, objects, throwUnsupportedExceptionOnEquals

  • コンストラクターのサマリー

    コンストラクター
    修飾子
    コンストラクター
    説明
    protected
    AbstractJsonContentAssert(JsonContent actual, ClassSE<?> selfType)
    指定された JSON ドキュメントのアサートを作成します。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    <T> org.assertj.core.api.AbstractObjectAssert<?,T>
    convertTo(ClassSE<T> target)
    実際の値が指定された target のインスタンスに変換できることを確認し、その型に絞り込まれた新しいアサーションオブジェクトを生成します。
    <ASSERT extends org.assertj.core.api.AbstractAssert<?, ?>>
    ASSERT
    convertTo(org.assertj.core.api.AssertFactory<?,ASSERT> assertFactory)
    実際の値が指定された AssertFactory で定義された型のインスタンスに変換できることを確認し、その型に絞り込まれた新しい Assert を返します。
    SELF
    doesNotHavePath(StringSE path)
    指定された JSON path が一致しないことを確認します。
    JsonPathValueAssert
    extractingPath(StringSE path)
    指定された JSON path が存在することを確認し、その後のアサーションのために JSON 値を抽出します。
    SELF
    hasPath(StringSE path)
    指定された JSON path が一致することを確認します。
    SELF
    hasPathSatisfying(StringSE path, ConsumerSE<org.assertj.core.api.AssertProvider<JsonPathValueAssert>> valueRequirements)
    指定された JSON path が、指定された valueRequirements を満たす JSON 値とともに存在することを確認します。
    SELF
    isEqualTo(CharSequenceSE expected)
    実際の値が指定された JSON と厳密に等しいことを確認します。
    SELF
    isEqualTo(CharSequenceSE expected, JsonComparator comparator)
    実際の値が指定された JSON と等しいことを確認します。
    SELF
    isEqualTo(CharSequenceSE expected, JsonCompareMode compareMode)
    実際の値が指定された JSON と等しいことを確認します。
    SELF
    isEqualTo(Resource expected, JsonComparator comparator)
    実際の値が指定された JSON Resource と等しいことを確認します。
    SELF
    isEqualTo(Resource expected, JsonCompareMode compareMode)
    実際の値が指定された JSON Resource と等しいことを確認します。
    SELF
    isLenientlyEqualTo(CharSequenceSE expected)
    実際の値が指定された JSON と等しい leniently であることを確認します。
    SELF
    isLenientlyEqualTo(Resource expected)
    実際の値が leniently であり、指定された JSON Resource と等しいことを確認します。
    SELF
    isNotEqualTo(CharSequenceSE expected)
    実際の値が指定された JSON と厳密に等しくないことを確認します。
    SELF
    isNotEqualTo(CharSequenceSE expected, JsonComparator comparator)
    実際の値が指定された JSON と等しくないことを確認します。
    SELF
    isNotEqualTo(CharSequenceSE expected, JsonCompareMode compareMode)
    実際の値が指定された JSON と等しくないことを確認します。
    SELF
    isNotEqualTo(Resource expected, JsonComparator comparator)
    実際の値が指定された JSON Resource と等しくないことを確認します。
    SELF
    isNotEqualTo(Resource expected, JsonCompareMode compareMode)
    実際の値が指定された JSON Resource と等しくないことを確認します。
    SELF
    isNotLenientlyEqualTo(CharSequenceSE expected)
    実際の値が指定された JSON と等しい leniently ではないことを確認します。
    SELF
    isNotLenientlyEqualTo(Resource expected)
    実際の値が指定された JSON Resource と等しい leniently ではないことを確認します。
    SELF
    isNotStrictlyEqualTo(CharSequenceSE expected)
    実際の値が指定された JSON と等しい strictly ではないことを確認します。
    SELF
    isNotStrictlyEqualTo(Resource expected)
    実際の値が指定された JSON Resource と等しい strictly ではないことを確認します。
    SELF
    isStrictlyEqualTo(CharSequenceSE expected)
    実際の値が指定された JSON と等しい strictly であることを確認します。
    SELF
    isStrictlyEqualTo(Resource expected)
    実際の値が strictly であり、指定された JSON Resource と等しいことを確認します。
    SELF
    withCharset(CharsetSE charset)
    リソースをロードするために使用する CharsetSE をオーバーライドします。
    SELF
    withResourceLoadClass(ClassSE<?> resourceLoadClass)
    リソースをロードするために使用されるクラスをオーバーライドします。

    クラス org.assertj.core.api.AbstractObjectAssert から継承されたメソッド

    as, as, doesNotReturn, extracting, extracting, extracting, extracting, extracting, extracting, extractingForProxy, getComparatorsByType, hasAllNullFieldsOrProperties, hasAllNullFieldsOrPropertiesExcept, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, hasOnlyFields, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, newObjectAssert, returns, usingComparatorForFields, usingComparatorForType, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison

    クラス org.assertj.core.api.AbstractAssert から継承されたメソッド

    actual, areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, doesNotMatch, doesNotMatch, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingEquals, usingEquals, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, finalize, getClass, notify, notifyAll, toString, wait, waitSE, waitSE

    インターフェース org.assertj.core.api.Descriptable から継承されたメソッド

    as, describedAs, describedAs

  • コンストラクターの詳細

    • AbstractJsonContentAssert

      protected AbstractJsonContentAssert(@Nullable JsonContent actual, ClassSE<?> selfType)
      指定された JSON ドキュメントのアサートを作成します。
      パラメーター:
      actual - 主張する JSON ドキュメント
      selfType - このアサートの実装型

  • メソッドの詳細

    • convertTo

      public <T> org.assertj.core.api.AbstractObjectAssert<?,T> convertTo(ClassSE<T> target)
      実際の値が指定された target のインスタンスに変換できることを確認し、その型に絞り込まれた新しいアサーションオブジェクトを生成します。
      パラメーター:
      target - 実際の値を変換する型SE

    • convertTo

      public <ASSERT extends org.assertj.core.api.AbstractAssert<?, ?>> ASSERT convertTo(org.assertj.core.api.AssertFactory<?,ASSERT> assertFactory)
      実際の値が指定された AssertFactory で定義された型のインスタンスに変換できることを確認し、その型に絞り込まれた新しい Assert を返します。

      InstanceOfAssertFactories は、Assertions.assertThat(java.util.function.Predicate<T>) でサポートされているすべての型に対して静的ファクトリを提供します。AssertFactory を実装することで、追加のファクトリを作成できます。

      例:

      
 // Check that the JSON document is an array of 3 users
 assertThat(json).convertTo(InstanceOfAssertFactories.list(User.class))
         hasSize(3); // ListAssert of User
      パラメーター:
      assertFactory - 定義する型の絞り込まれた Assert を生成するために使用する AssertFactory。

    • extractingPath

      public JsonPathValueAssert extractingPath(StringSE path)
      指定された JSON path が存在することを確認し、その後のアサーションのために JSON 値を抽出します。
      パラメーター:
      path - JsonPath 式
      関連事項:

    • hasPathSatisfying

      public SELF hasPathSatisfying(StringSE path, ConsumerSE<org.assertj.core.api.AssertProvider<JsonPathValueAssert>> valueRequirements)
      指定された JSON path が、指定された valueRequirements を満たす JSON 値とともに存在することを確認します。
      パラメーター:
      path - JsonPath 式
      valueRequirements - アサーションオブジェクトの ConsumerSE

    • hasPath

      public SELF hasPath(StringSE path)
      指定された JSON path が一致することを確認します。演算子を含むパスの場合、これはパス式が有効であることを検証しますが、結果が得られるかどうかは検証しません。
      パラメーター:
      path - JsonPath 式

    • doesNotHavePath

      public SELF doesNotHavePath(StringSE path)
      指定された JSON path が一致しないことを確認します。
      パラメーター:
      path - JsonPath 式

    • isEqualTo

      public SELF isEqualTo(@Nullable CharSequenceSE expected)
      実際の値が指定された JSON と厳密に等しいことを確認します。expected 値には JSON 自体が含まれる場合がありますが、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前
      関連事項:

    • isEqualTo

      public SELF isEqualTo(@Nullable CharSequenceSE expected, JsonCompareMode compareMode)
      実際の値が指定された JSON と等しいことを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前
      compareMode - チェック時に使用される比較モード

    • isEqualTo

      public SELF isEqualTo(Resource expected, JsonCompareMode compareMode)
      実際の値が指定された JSON Resource と等しいことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース
      compareMode - チェック時に使用される比較モード

    • isEqualTo

      public SELF isEqualTo(@Nullable CharSequenceSE expected, JsonComparator comparator)
      実際の値が指定された JSON と等しいことを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前
      comparator - チェック時に使用されるコンパレータ

    • isEqualTo

      public SELF isEqualTo(Resource expected, JsonComparator comparator)
      実際の値が指定された JSON Resource と等しいことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース
      comparator - チェック時に使用されるコンパレータ

    • isLenientlyEqualTo

      public SELF isLenientlyEqualTo(@Nullable CharSequenceSE expected)
      実際の値が指定された JSON と等しい leniently であることを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前

    • isLenientlyEqualTo

      public SELF isLenientlyEqualTo(Resource expected)
      実際の値が leniently であり、指定された JSON Resource と等しいことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース

    • isStrictlyEqualTo

      public SELF isStrictlyEqualTo(@Nullable CharSequenceSE expected)
      実際の値が指定された JSON と等しい strictly であることを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前

    • isStrictlyEqualTo

      public SELF isStrictlyEqualTo(Resource expected)
      実際の値が strictly であり、指定された JSON Resource と等しいことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース

    • isNotEqualTo

      public SELF isNotEqualTo(@Nullable CharSequenceSE expected)
      実際の値が指定された JSON と厳密に等しくないことを確認します。expected 値には JSON 自体が含まれる場合がありますが、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前
      関連事項:

    • isNotEqualTo

      public SELF isNotEqualTo(@Nullable CharSequenceSE expected, JsonCompareMode compareMode)
      実際の値が指定された JSON と等しくないことを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前
      compareMode - チェック時に使用される比較モード

    • isNotEqualTo

      public SELF isNotEqualTo(Resource expected, JsonCompareMode compareMode)
      実際の値が指定された JSON Resource と等しくないことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース
      compareMode - チェック時に使用される比較モード

    • isNotEqualTo

      public SELF isNotEqualTo(@Nullable CharSequenceSE expected, JsonComparator comparator)
      実際の値が指定された JSON と等しくないことを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前
      comparator - チェック時に使用されるコンパレータ

    • isNotEqualTo

      public SELF isNotEqualTo(Resource expected, JsonComparator comparator)
      実際の値が指定された JSON Resource と等しくないことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース
      comparator - チェック時に使用されるコンパレータ

    • isNotLenientlyEqualTo

      public SELF isNotLenientlyEqualTo(@Nullable CharSequenceSE expected)
      実際の値が指定された JSON と等しい leniently ではないことを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前

    • isNotLenientlyEqualTo

      public SELF isNotLenientlyEqualTo(Resource expected)
      実際の値が指定された JSON Resource と等しい leniently ではないことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース

    • isNotStrictlyEqualTo

      public SELF isNotStrictlyEqualTo(@Nullable CharSequenceSE expected)
      実際の値が指定された JSON と等しい strictly ではないことを確認します。expected 値には JSON 自体が含まれる場合があります。また、.json で終わる場合は、クラスパスからロードされるリソースの名前が含まれます。
      パラメーター:
      expected - 予期される JSON、または予期される JSON を含むリソースの名前

    • isNotStrictlyEqualTo

      public SELF isNotStrictlyEqualTo(Resource expected)
      実際の値が指定された JSON Resource と等しい strictly ではないことを確認します。

      リソース抽象化により、いくつかの入力型を提供できます。

      パラメーター:
      expected - 予期される JSON を含むリソース

    • withResourceLoadClass

      public SELF withResourceLoadClass(@Nullable ClassSE<?> resourceLoadClass)
      リソースをロードするために使用されるクラスをオーバーライドします。

      リソースは、絶対位置から、または指定されたクラスからの相対位置からロードできます。たとえば、リソースクラスとして com.example.MyClass を指定すると、"my-file.json" を使用して /com/example/my-file.json をロードできます。

      パラメーター:
      resourceLoadClass - リソースをロードするために使用されるクラス、または絶対パスのみを使用する null 

    • withCharset

      public SELF withCharset(@Nullable CharsetSE charset)
      リソースをロードするために使用する CharsetSE をオーバーライドします。

      デフォルトでは、リソースは UTF-8 を使用してロードされます。

      パラメーター:
      charset - 使用する文字セット、またはデフォルトを使用するには null