パッケージ jakarta.faces.validator

クラス LengthValidator

java.lang.ObjectSE
jakarta.faces.validator.LengthValidator
実装されているすべてのインターフェース:
PartialStateHolderStateHolderValidatorEventListenerSE

public class LengthValidator extends ObjectSE implements Validator, PartialStateHolder

LengthValidator は、関連するコンポーネントの値の文字列表現の文字数をチェックする Validator です。次のアルゴリズムが実装されています。

  • 必要に応じて、toString() メソッドを呼び出して、渡された値を文字列に変換します。
  • この Validator で maximum プロパティが構成されている場合は、変換された文字列の長さをこの制限と照合します。文字列の長さが指定された最大値より大きい場合は、MAXIMUM_MESSAGE_ID メッセージを含む ValidatorException をスローします。
  • この Validator で minimum プロパティが構成されている場合は、変換された文字列の長さをこの制限と照合します。文字列の長さが指定された最小値より短い場合は、MINIMUM_MESSAGE_ID メッセージを含む ValidatorException をスローします。

ValidatorException がスローされる上記のすべてのケースで、検証パラメーターと一致するパラメーターがメッセージにある場合、これらのパラメーターの値は、コンバーター ID jakarta.faces.Number でアプリケーションに登録された Converter を使用して変換する必要があります。これにより、現在の Locale に従って値をローカライズできます。

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    最大長のチェックが失敗した場合に作成される FacesMessage のメッセージ識別子。
    static final StringSE
    最小長のチェックが失敗した場合に作成される FacesMessage のメッセージ ID。
    static final StringSE
    このバリデーターの標準バリデーター ID。
  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    事前構成された制限のない Validator を構築します。
    LengthValidator(int maximum)
    指定された事前構成された制限で Validator を構築します。
    LengthValidator(int maximum, int minimum)
    指定された事前構成された制限で Validator を構築します。
  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    PartialStateHolder を非デルタ追跡状態にリセットします。
    boolean
    equals(ObjectSE otherObj)
    int
    この Validator によって適用される最大長、または最大長が設定されていない場合は 0 を返します。
    int
    この Validator によって適用される最小の長さ、または最小値が設定されていない場合は 0 を返します。
    int
    boolean
    デルタ状態の変更が追跡されている場合は true を返し、それ以外の場合は false を返します。
    boolean
    true の場合、このインターフェースを実装するオブジェクトは、状態の保存または復元に参加してはなりません。
    void
    ランタイムは、コンポーネントが初期状態であることを示すために、適切な時間にビュー内のこのインターフェースの各インスタンスで PartialStateHolder.markInitialState() メソッドが呼び出されることを確認する必要があります。
    void
    state オブジェクトのエントリから状態を復元するために必要な処理を実行します。
    インスタンスの状態を Serializable オブジェクトとして取得します。
    void
    setMaximum(int maximum)
    この Validator によって適用される最大長を設定します。
    void
    setMinimum(int minimum)
    この Validator によって適用される最小の長さを設定します。
    void
    setTransient(boolean transientValue)
    このインターフェースを実装するオブジェクトが状態の保存または復元に参加する必要があるかどうかを示します
    void
    validate(FacesContext context, UIComponent component, ObjectSE value)
    指定された UIComponent に対してこの Validator によって実装正しさのチェックを行います

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

    clone, finalize, getClass, notify, notifyAll, toString, wait, waitSE, waitSE
  • フィールドの詳細

    • VALIDATOR_ID

      public static final StringSE VALIDATOR_ID

      このバリデーターの標準バリデーター ID。

      関連事項:
    • MAXIMUM_MESSAGE_ID

      public static final StringSE MAXIMUM_MESSAGE_ID

      最大長のチェックが失敗した場合に作成される FacesMessage のメッセージ識別子。このメッセージのメッセージフォーマット文字列には、オプションで次のプレースホルダーを含めることができます。

      • {0} は、構成された最大長に置き換えられました。
      • {1} は、値がこのメッセージを生成した入力コンポーネントのラベルである String に置き換えられました。
      関連事項:
    • MINIMUM_MESSAGE_ID

      public static final StringSE MINIMUM_MESSAGE_ID

      最小長のチェックが失敗した場合に作成される FacesMessage のメッセージ ID。このメッセージのメッセージフォーマット文字列には、オプションで次のプレースホルダーを含めることができます。

      • {0} は、構成された最小長に置き換えられました。
      • {1} は、値がこのメッセージを生成した入力コンポーネントのラベルである String に置き換えられました。
      関連事項:
  • コンストラクターの詳細

    • LengthValidator

      public LengthValidator()

      事前構成された制限のない Validator を構築します。

    • LengthValidator

      public LengthValidator(int maximum)

      指定された事前構成された制限で Validator を構築します。

      パラメーター:
      maximum - 許可する最大値
    • LengthValidator

      public LengthValidator(int maximum, int minimum)

      指定された事前構成された制限で Validator を構築します。

      パラメーター:
      maximum - 許可する最大値
      minimum - 許可する最小値
  • メソッドの詳細

    • getMaximum

      public int getMaximum()

      この Validator によって適用される最大長、または最大長が設定されていない場合は 0 を返します。

      戻り値:
      最大
    • setMaximum

      public void setMaximum(int maximum)

      この Validator によって適用される最大長を設定します。

      パラメーター:
      maximum - 新しい最大値
    • getMinimum

      public int getMinimum()

      この Validator によって適用される最小の長さ、または最小値が設定されていない場合は 0 を返します。

      戻り値:
      最小値
    • setMinimum

      public void setMinimum(int minimum)

      この Validator によって適用される最小の長さを設定します。

      パラメーター:
      minimum - 新しい最小値
    • validate

      public void validate(FacesContext context, UIComponent component, ObjectSE value) throws ValidatorException
      インターフェースからコピーされた説明: Validator

      指定された UIComponent に対してこの Validator によって実装正しさのチェックを行います。違反が見つかった場合は、障害を説明する FacesMessage を含む ValidatorException がスローされます。

      バリデーターがバージョン 2 以降の仕様に完全に準拠するためには、null または空の値に対処することを特に意図していない限り、null または空の値の検証に失敗してはなりません。アプリケーション全体の <context-param> は、Jakarta Faces 1.2 用に設計されたバリデーターが Jakarta Faces 2 以降で動作できるようにするために提供されています。この下位互換性の動作を有効にするには、jakarta.faces.VALIDATE_EMPTY_FIELDS <context-param> を false に設定する必要があります。

      次で指定:
      インターフェース Validatorvalidate 
      パラメーター:
      context - 処理中のリクエストの FacesContext
      component - 正当性をチェックしている UIComponent
      value - 検証する値
      例外:
      NullPointerExceptionSE - context または component が null の場合
      ValidatorException - 検証が失敗した場合
    • equals

      public boolean equals(ObjectSE otherObj)
      オーバーライド:
      クラス ObjectSEequalsSE 
    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSEhashCode 
    • saveState

      public ObjectSE saveState(FacesContext context)
      インターフェースからコピーされた説明: StateHolder

      インスタンスの状態を Serializable オブジェクトとして取得します。

      このインターフェースを実装するクラスが、StateHolder を実装するインスタンス(イベントハンドラー、バリデーターなどを含む UIComponent など)への参照を持っている場合、このメソッドはそれらすべてのインスタンスで StateHolder.saveState(jakarta.faces.context.FacesContext) メソッドも呼び出す必要があります。このメソッドは、子とファセットの状態を保存してはなりませんそれは StateManager を介して行われます

      このメソッドは、実装オブジェクトの状態を変更してはなりません。つまり、このコードを実行した後:

       
       Object state = component.saveState(facesContext);
       
       

      component は、実行前と同じでなければなりません。

      このメソッドからの戻り値は Serializable でなければなりません

      次で指定:
      インターフェース StateHoldersaveState 
      パラメーター:
      context - Faces コンテキスト。
      戻り値:
      保存された状態。
    • restoreState

      public void restoreState(FacesContext context, ObjectSE state)
      インターフェースからコピーされた説明: StateHolder

      state オブジェクトのエントリから状態を復元するために必要な処理を実行します。

      このインターフェースを実装するクラスが、StateHolder も実装するインスタンスへの参照を持っている場合(イベントハンドラー、バリデーターなどを備えた UIComponent など)、このメソッドはそれらすべてのインスタンスで StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) メソッドも呼び出す必要があります。

      state 引数が null の場合、アクションを実行せずに戻ります。

      次で指定:
      インターフェース StateHolderrestoreState 
      パラメーター:
      context - Faces コンテキスト。
      state - 状態。
    • isTransient

      public boolean isTransient()
      インターフェースからコピーされた説明: StateHolder

      true の場合、このインターフェースを実装するオブジェクトは、状態の保存または復元に参加してはなりません。

      次で指定:
      インターフェース StateHolderisTransient 
      戻り値:
      一時的な場合は true、それ以外の場合は false
    • setTransient

      public void setTransient(boolean transientValue)
      インターフェースからコピーされた説明: StateHolder

      このインターフェースを実装するオブジェクトが状態の保存または復元に参加する必要があるかどうかを示します

      次で指定:
      インターフェース StateHoldersetTransient 
      パラメーター:
      transientValue - このオブジェクトが 状態の保存または復元に参加しない場合はブール値 true を渡し、それ以外の場合は false を渡します。
    • markInitialState

      public void markInitialState()
      インターフェースからコピーされた説明: PartialStateHolder

      ランタイムは、コンポーネントが初期状態であることを示すために、適切な時間にビュー内のこのインターフェースの各インスタンスで PartialStateHolder.markInitialState() メソッドが呼び出されることを確認する必要があります。インターフェースの実装者は、markInitialState() が呼び出されてから PartialStateHolder.clearInitialState() が呼び出されるまで PartialStateHolder.initialStateMarked() が true を返すことを確認する必要があります。その後、initialStateMarked() は false を返す必要があります。また、インスタンスが initialStateMarked() から true を返す間、実装は StateHolder.saveState(jakarta.faces.context.FacesContext) の実装で変更された状態のみを返す必要があります。

      次で指定:
      インターフェース PartialStateHoldermarkInitialState 
    • initialStateMarked

      public boolean initialStateMarked()
      インターフェースからコピーされた説明: PartialStateHolder

      デルタ状態の変更が追跡されている場合は true を返し、それ以外の場合は false を返します。

      次で指定:
      インターフェース PartialStateHolderinitialStateMarked 
      戻り値:
      初期状態がマークされている場合は true、それ以外の場合は false
    • clearInitialState

      public void clearInitialState()
      インターフェースからコピーされた説明: PartialStateHolder

      PartialStateHolder を非デルタ追跡状態にリセットします。

      次で指定:
      インターフェース PartialStateHolderclearInitialState