パッケージ org.springframework.binding.message

クラス MessageBuilder

java.lang.ObjectSE
org.springframework.binding.message.MessageBuilder
public class MessageBuilder extends ObjectSE
MessageResolver オブジェクトをプログラムで構築するための便利なビルダー。検証ロジックなどのモデルコードで、検証メッセージを便利に記録するために使用されます。メッセージテキストをハードコードするメッセージリゾルバーと、message resource bundle からテキストを取得するメッセージリゾルバーの生成をサポートします。使用例:

new MessageBuilder().error().source("field").code("mycode").arg(arg1).arg(arg2).defaultText("text").build();

作成者:
Keith Donald, Jeremy Grelle

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

    • MessageBuilder

      public MessageBuilder()

  • メソッドの詳細

    • info

      public MessageBuilder info()
      構築中のメッセージが情報メッセージであることを記録します。
      戻り値:
      スムーズな API 使用のために

    • warning

      public MessageBuilder warning()
      構築中のメッセージが警告メッセージであることを記録します。
      戻り値:
      スムーズな API 使用のために

    • error

      public MessageBuilder error()
      構築中のメッセージがエラーメッセージであることを記録します。
      戻り値:
      スムーズな API 使用のために

    • fatal

      public MessageBuilder fatal()
      構築中のメッセージが致命的なメッセージであることを記録します。
      戻り値:
      スムーズな API 使用のために

    • source

      public MessageBuilder source(ObjectSE source)
      構築中のメッセージが指定されたソースに反していることを記録します。
      パラメーター:
      source - メッセージを関連付けるソース
      戻り値:
      スムーズな API 使用のために

    • code

      public MessageBuilder code(StringSE code)
      構築中のメッセージは、提供されたコードを使用してテキストを解決しようとすることを記録します。コードをコードリストに追加します。このメソッドを連続して呼び出すと、追加のコードが追加されます。コードは追加された順序で適用されます。
      パラメーター:
      code - メッセージコード
      戻り値:
      スムーズな API 使用のために

    • codes

      public MessageBuilder codes(StringSE... codes)
      構築中のメッセージは、提供されたコードを使用してテキストを解決しようとすることを記録します。コードをコードリストに追加します。このメソッドを連続して呼び出すと、追加のコードが追加されます。コードは追加された順序で適用されます。
      パラメーター:
      codes - メッセージコード。null の場合、変更は行われません。
      戻り値:
      スムーズな API 使用のために

    • arg

      public MessageBuilder arg(ObjectSE arg)
      構築中のメッセージに可変引数があることを記録します。引数を引数リストに追加します。このメソッドを連続して呼び出すと、追加の引数が追加されます。引数は追加された順序で適用されます。
      パラメーター:
      arg - メッセージ引数値
      戻り値:
      スムーズな API 使用のために

    • args

      public MessageBuilder args(ObjectSE... args)
      構築中のメッセージに可変引数があることを記録します。引数を引数リストに追加します。このメソッドを連続して呼び出すと、追加の引数が追加されます。引数は追加された順序で適用されます。
      パラメーター:
      args - メッセージ引数の値。null の場合は変更されません
      戻り値:
      スムーズな API 使用のために

    • resolvableArg

      public MessageBuilder resolvableArg(ObjectSE arg)
      構築中のメッセージに可変引数があり、その表示値も MessageSourceResolvable であることを記録します。引数を引数リストに追加します。このメソッドを連続して呼び出すと、解決可能な引数がさらに追加されます。引数は追加された順に適用されます。
      パラメーター:
      arg - 解決可能なメッセージ引数
      戻り値:
      スムーズな API 使用のために

    • resolvableArgs

      public MessageBuilder resolvableArgs(ObjectSE... args)
      構築中のメッセージに可変引数があり、その表示値も MessageSourceResolvable インスタンスであることを記録します。引数を引数リストに追加します。このメソッドを連続して呼び出すと、解決可能な引数がさらに追加されます。引数は追加された順に適用されます。
      パラメーター:
      args - 解決可能なメッセージ引数
      戻り値:
      スムーズな API 使用のために

    • defaultText

      public MessageBuilder defaultText(StringSE text)
      構築中のメッセージのフォールバックテキストを記録します。メッセージにコードがない場合、これが常にテキストとして使用されます。メッセージにコードがあっても解決できない場合、これが常にテキストとして使用されます。
      パラメーター:
      text - デフォルトのテキスト
      戻り値:
      スムーズな API 使用のために

    • build

      public MessageResolver build()
      解決されるメッセージを構築します。ビルダーの指示の記録が終了した後に呼び出されます。
      戻り値:
      構築されたメッセージリゾルバー