パッケージ jakarta.servlet.jsp.tagext

クラス TagExtraInfo

  • public abstract class TagExtraInfo
extends ObjectSE
    TLD に記述されていない追加の変換時情報を記述するためにタグライブラリ作成者によって提供されるオプションのクラス。TagExtraInfo クラスは、タグライブラリ記述子ファイル（TLD）でメンションされています。

    このクラスは使用できます:

    • タグがスクリプト変数を定義していることを示す
    • タグ属性の変換時検証を実行します。

    getTagInfo() の呼び出しによって返される初期値が、変換されるタグの TagInfo オブジェクトに対応するのは、JSP トランスレーターの責任です。setTagInfo() への明示的な呼び出しが行われた場合、渡されたオブジェクトは getTagInfo() への後続の呼び出しで返されます。

    getTagInfo() によって返される値に影響を与える唯一の方法は、setTagInfo() 呼び出しを使用することです。TagExtraInfo.setTagInfo() は、変換されるタグに対応する TagInfo オブジェクトを使用して、JSP トランスレーターによって呼び出されます。呼び出しは、validate() での呼び出しの前、および getVariableInfo() での呼び出しの前に行う必要があります。

    注意 : getVariableInfo() への呼び出しから 1 つ以上の要素を持つ VariableInfo 配列を返す関連付けられた TagExtraInfo 実装を持つ、1 つ以上の可変サブ要素を持つ TLD のタグ定義の (変換時) エラーです。

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

      • TagExtraInfo

        public TagExtraInfo()
        唯一のコンストラクター。(サブクラスコンストラクターによる呼び出しの場合、通常は暗黙的です。)

    • メソッドの詳細

      • getVariableInfo

        public VariableInfo[] getVariableInfo​(TagData data)
        この TagExtraInfo インスタンスに関連付けられたタグによって定義されたスクリプト変数に関する情報。リクエスト時属性は、TagData パラメーターでそのように示されます。
        パラメーター:
        data - TagData インスタンス。
        戻り値:
        VariableInfo データの配列。スクリプト変数を定義しない場合は、null または長さがゼロの配列。

      • isValid

        public boolean isValid​(TagData data)
        属性の変換時検証。リクエスト時属性は、TagData パラメーターでそのように示されます。検証を行うには、validate() メソッドを使用することをお勧めします。これは、より詳細な情報を返すことができるためです。
        パラメーター:
        data - TagData インスタンス。
        戻り値:
        このタグインスタンスが有効かどうか。
        関連事項:
        validate(jakarta.servlet.jsp.tagext.TagData)

      • validate

        public ValidationMessage[] validate​(TagData data)
        属性の変換時検証。リクエスト時属性は、TagData パラメーターでそのように示されます。高品質の検証メッセージが可能なため、これは検証を行うための推奨される方法です（ただし、isValid() は引き続き機能します）。

        JSP 2.0 以降のコンテナーは、isValid() ではなく validate() を呼び出します。このメソッドのデフォルトの実装では、isValid() を呼び出します。isValid() が false を返す場合、isValid() が false を返したことを示す一般的な ValidationMessage[] が返されます。

        パラメーター:
        data - TagData インスタンス。
        戻り値:
        null オブジェクト、またはエラーがない場合は長さ 0 の配列、それ以外の場合は ValidationMessages の配列。
        導入:
        JSP 2.0

      • setTagInfo

        public final void setTagInfo​(TagInfo tagInfo)
        このクラスの TagInfo を設定します。
        パラメーター:
        tagInfo - このインスタンスが拡張している TagInfo

      • getTagInfo

        public final TagInfo getTagInfo()
        このクラスの TagInfo を取得します。
        戻り値:
        このインスタンスが拡張している taginfo インスタンス