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

クラス AbstractJsonMarshalTester<T>

java.lang.ObjectSE
org.springframework.boot.test.json.AbstractJsonMarshalTester<T>
型パラメーター:
T - テスト中の型
既知の直属サブクラス
GsonTester、JacksonTester、JsonbTester
public abstract class AbstractJsonMarshalTester<T> extends ObjectSE
AssertJ ベースの JSON マーシャルテスターの基本クラス。JSON コンテンツの read、write または parse に続く特定のアサートを公開します。通常、AssertJ assertThat 呼び出しと組み合わせて使用されます。例：
 public class ExampleObjectJsonTests {

     private AbstractJsonTester<ExampleObject> json = //...

     @Test
     public void testWriteJson() {
         ExampleObject object = //...
         assertThat(json.write(object)).isEqualToJson("expected.json");
         assertThat(json.read("expected.json")).isEqualTo(object);
     }

 }
サポートされるアサーションの完全なリストについては、JsonContentAssert および ObjectContentAssert を参照してください。

このライブラリを使用するには、JSONAssert がテストクラスパス上にある必要があります。

導入:
1.4.0
作成者:
Phillip Webb
関連事項:

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

    • AbstractJsonMarshalTester

      protected AbstractJsonMarshalTester()
      初期化されていない新しい AbstractJsonMarshalTester インスタンスを作成します。

    • AbstractJsonMarshalTester

      public AbstractJsonMarshalTester(ClassSE<?> resourceLoadClass, ResolvableType type)
      新しい AbstractJsonMarshalTester インスタンスを作成します。
      パラメーター:
      resourceLoadClass - 相対クラスパスリソースをロードするときに使用されるソースクラス
      type - テスト中の型

  • メソッドの詳細

    • initialize

      protected final void initialize(ClassSE<?> resourceLoadClass, ResolvableType type)
      マーシャルテスターを使用できるように初期化します。
      パラメーター:
      resourceLoadClass - 相対クラスパスリソースをロードするときに使用されるソースクラス
      type - テスト中の型

    • getType

      protected final ResolvableType getType()
      テスト中の型を返します。
      戻り値:
      テスト中の型

    • getResourceLoadClass

      protected final ClassSE<?> getResourceLoadClass()
      相対リソースをロードするために使用されるクラスを返します。
      戻り値:
      リソースロードクラス

    • write

      public JsonContent<T> write(T value) throws IOExceptionSE
      特定の値の書き込みから JsonContent を返します。
      パラメーター:
      value - 書き込む値
      戻り値:
      JsonContent
      例外:
      IOExceptionSE - 書き込みエラー時

    • getJsonContent

      protected JsonContent<T> getJsonContent(StringSE json)
      ソース JSON 文字列から JsonContent インスタンスを取得するために使用されるファクトリメソッド。
      パラメーター:
      json - ソース JSON
      戻り値:
      新しい JsonContent インスタンス
      導入:
      2.1.5

    • parseObject

      public T parseObject(byte[] jsonBytes) throws IOExceptionSE
      特定の JSON バイトの解析から作成されたオブジェクトを返します。
      パラメーター:
      jsonBytes - ソース JSON バイト
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 解析エラー時

    • parse

      public ObjectContent<T> parse(byte[] jsonBytes) throws IOExceptionSE
      特定の JSON バイトの解析から ObjectContent を返します。
      パラメーター:
      jsonBytes - ソース JSON バイト
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 解析エラー時

    • parseObject

      public T parseObject(StringSE jsonString) throws IOExceptionSE
      特定の JSON 文字列の解析から作成されたオブジェクトを返します。
      パラメーター:
      jsonString - ソース JSON 文字列
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 解析エラー時

    • parse

      public ObjectContent<T> parse(StringSE jsonString) throws IOExceptionSE
      特定の JSON 文字列の解析から ObjectContent を返します。
      パラメーター:
      jsonString - ソース JSON 文字列
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 解析エラー時

    • readObject

      public T readObject(StringSE resourcePath) throws IOExceptionSE
      指定されたクラスパスリソースからの読み取りから作成されたオブジェクトを返します。
      パラメーター:
      resourcePath - ソースリソースパス。絶対パスまたはコンストラクターに渡される resourceLoadClass からの相対パスの場合があります
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時

    • read

      public ObjectContent<T> read(StringSE resourcePath) throws IOExceptionSE
      指定されたクラスパスリソースからの読み取りから ObjectContent を返します。
      パラメーター:
      resourcePath - ソースリソースパス。絶対パスまたはコンストラクターに渡される resourceLoadClass からの相対パスの場合があります
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 読み取りエラー時

    • readObject

      public T readObject(FileSE file) throws IOExceptionSE
      指定されたファイルから読み込んで作成されたオブジェクトを返します。
      パラメーター:
      file - ソースファイル
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時

    • read

      public ObjectContent<T> read(FileSE file) throws IOExceptionSE
      指定されたファイルからの読み取りから ObjectContent を返します。
      パラメーター:
      file - ソースファイル
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 読み取りエラー時

    • readObject

      public T readObject(InputStreamSE inputStream) throws IOExceptionSE
      指定された入力ストリームからの読み取りから作成されたオブジェクトを返します。
      パラメーター:
      inputStream - ソース入力ストリーム
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時

    • read

      public ObjectContent<T> read(InputStreamSE inputStream) throws IOExceptionSE
      指定された入力ストリームからの読み取りから ObjectContent を返します。
      パラメーター:
      inputStream - ソース入力ストリーム
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 読み取りエラー時

    • readObject

      public T readObject(Resource resource) throws IOExceptionSE
      指定されたリソースからの読み取りから作成されたオブジェクトを返します。
      パラメーター:
      resource - ソースリソース
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時

    • read

      public ObjectContent<T> read(Resource resource) throws IOExceptionSE
      指定されたリソースからの読み取りから ObjectContent を返します。
      パラメーター:
      resource - ソースリソース
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 読み取りエラー時

    • readObject

      public T readObject(ReaderSE reader) throws IOExceptionSE
      指定されたリーダーからの読み取りから作成されたオブジェクトを返します。
      パラメーター:
      reader - ソースリーダー
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時

    • read

      public ObjectContent<T> read(ReaderSE reader) throws IOExceptionSE
      指定されたリーダーからの読み取りから ObjectContent を返します。
      パラメーター:
      reader - ソースリーダー
      戻り値:
      ObjectContent
      例外:
      IOExceptionSE - 読み取りエラー時

    • writeObject

      protected abstract StringSE writeObject(T value, ResolvableType type) throws IOExceptionSE
      指定されたオブジェクトを JSON 文字列に書き込みます。
      パラメーター:
      value - ソース値 (非 null)
      type - 結果の型 (非 null)
      戻り値:
      JSON 文字列
      例外:
      IOExceptionSE - 書き込みエラー時

    • readObject

      protected T readObject(InputStreamSE inputStream, ResolvableType type) throws IOExceptionSE
      指定された入力ストリームから読み取り、指定された型のオブジェクトを作成します。デフォルトの実装は readObject(Reader, ResolvableType) に委譲します。
      パラメーター:
      inputStream - ソース入力ストリーム (非 null)
      type - 結果の型 (非 null)
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時

    • readObject

      protected abstract T readObject(ReaderSE reader, ResolvableType type) throws IOExceptionSE
      指定したリーダーから読み取り、指定した型のオブジェクトを作成します。
      パラメーター:
      reader - ソースリーダー (非 null)
      type - 結果の型 (非 null)
      戻り値:
      結果のオブジェクト
      例外:
      IOExceptionSE - 読み取りエラー時