クラス BindStatus

java.lang.ObjectSE
org.springframework.web.reactive.result.view.BindStatus

public class BindStatus extends ObjectSE
フィールドまたはオブジェクトのバインドステータスを公開する単純なアダプター。FreeMarker マクロおよびその他のタグライブラリによって変数として設定されます。

明らかに、オブジェクトステータス表現(つまり、フィールドレベルではなくオブジェクトレベルのエラー)には、式と値はありませんが、エラーコードとメッセージのみがあります。わかりやすくするため、および同じタグとマクロを使用できるようにするために、両方のシナリオで同じステータスクラスを使用しています。

導入:
5.0
作成者:
Rossen Stoyanchev, Juergen Hoeller
関連事項:
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    BindStatus(RequestContext requestContext, StringSE path, boolean htmlEscape)
    フィールドまたはオブジェクトのステータスを表す新しい BindStatus インスタンスを作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    findEditor(ClassSE<?> valueClass)
    このバインドされたステータスが現在バインドされているプロパティに関連付けられている、指定された値クラスの PropertyEditor を見つけます。
    フィールドの実際の値を返します。
    フィールドに適切な表示値を返します。
    このバインドステータスが現在バインドされているプロパティの PropertyEditor を返します。
    存在する場合、フィールドまたはオブジェクトの最初のエラーコードを返します。
    存在する場合、フィールドまたはオブジェクトのエラーコードを返します。
    存在する場合、フィールドまたはオブジェクトの最初のエラーメッセージを返します。
    存在する場合、フィールドまたはオブジェクトの解決されたエラーメッセージを返します。
    指定された区切り文字で区切られたすべてのメッセージを連結して、エラーメッセージ文字列を返します。
    このバインドステータスが現在関連付けられている Errors インスタンス(通常は BindingResult)を返します。
    それぞれのフィールドの入力名として HTML フォームで使用できるバインド式を返します。フィールド固有でない場合は null を返します。
    値とエラーが解決される Bean とプロパティパスを返します(例:
    フィールドの現在の値を返します。
    フィールドの 'Class' 型を取得します。
    boolean
    このステータスがフィールドまたはオブジェクトのエラーを表す場合に返されます。

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
  • コンストラクターの詳細

    • BindStatus

      public BindStatus(RequestContext requestContext, StringSE path, boolean htmlEscape) throws IllegalStateExceptionSE
      フィールドまたはオブジェクトのステータスを表す新しい BindStatus インスタンスを作成します。
      パラメーター:
      requestContext - 現在の RequestContext
      path - 値とエラーが解決される Bean とプロパティパス (たとえば "customer.address.street" )
      htmlEscape - HTML エスケープエラーメッセージと文字列値かどうか
      例外:
      IllegalStateExceptionSE - 対応する Errors オブジェクトが見つからない場合
  • メソッドの詳細

    • getPath

      public StringSE getPath()
      値とエラーが解決される Bean とプロパティパスを返します(例: "customer.address.street" )。
    • getExpression

      @Nullable public StringSE getExpression()
      それぞれのフィールドの入力名として HTML フォームで使用できるバインド式を返します。フィールド固有でない場合は null を返します。

      再送信に適したバインドパスを返します。例: "address.street"。「顧客」Bean にバインドされている場合、バインドタグに必要な完全なバインドパスは "customer.address.street" であることに注意してください。

    • getValue

      @Nullable public ObjectSE getValue()
      フィールドの現在の値、つまり、プロパティ値または拒否された更新のいずれかを返します。フィールド固有でない場合は、null を返します。

      元の値がすでに文字列であった場合、この値は HTML エスケープ文字列になります。

    • getValueType

      @Nullable public ClassSE<?> getValueType()
      フィールドの 'Class' 型を取得します。"getValue()" が "null" を返す可能性があるため、"getValue().getClass()" の代わりにこれを優先します。
    • getActualValue

      @Nullable public ObjectSE getActualValue()
      フィールドの実際の値、つまり生のプロパティ値、使用できない場合は null を返します。
    • getDisplayValue

      public StringSE getDisplayValue()
      フィールドに適切な表示値、つまり null でない場合は文字列化された値、null 値の場合は空の文字列を返します。

      元の値が null 以外の場合、この値は HTML エスケープ文字列になります。元の値の toString 結果は HTML エスケープされます。

    • isError

      public boolean isError()
      このステータスがフィールドまたはオブジェクトのエラーを表す場合に返されます。
    • getErrorCodes

      public StringSE[] getErrorCodes()
      存在する場合、フィールドまたはオブジェクトのエラーコードを返します。ない場合は null ではなく空の配列を返します。
    • getErrorCode

      public StringSE getErrorCode()
      存在する場合、フィールドまたはオブジェクトの最初のエラーコードを返します。
    • getErrorMessages

      public StringSE[] getErrorMessages()
      存在する場合、フィールドまたはオブジェクトの解決されたエラーメッセージを返します。ない場合は null ではなく空の配列を返します。
    • getErrorMessage

      public StringSE getErrorMessage()
      存在する場合、フィールドまたはオブジェクトの最初のエラーメッセージを返します。
    • getErrorMessagesAsString

      public StringSE getErrorMessagesAsString(StringSE delimiter)
      指定された区切り文字で区切られたすべてのメッセージを連結して、エラーメッセージ文字列を返します。
      パラメーター:
      delimiter - 区切り文字列。例: ","、"
      "
      戻り値:
      エラーメッセージ文字列
    • getErrors

      @Nullable public Errors getErrors()
      このバインドステータスが現在関連付けられている Errors インスタンス(通常は BindingResult)を返します。
      戻り値:
      現在のエラーインスタンス、または存在しない場合は null 
      関連事項:
    • getEditor

      @Nullable public PropertyEditorSE getEditor()
      このバインドステータスが現在バインドされているプロパティの PropertyEditor を返します。
      戻り値:
      現在の PropertyEditor、または存在しない場合は null 
    • findEditor

      @Nullable public PropertyEditorSE findEditor(ClassSE<?> valueClass)
      このバインドされたステータスが現在バインドされているプロパティに関連付けられている、指定された値クラスの PropertyEditor を見つけます。
      パラメーター:
      valueClass - エディターが必要とする値クラス
      戻り値:
      関連する PropertyEditor、またはない場合は null 
    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSEtoString