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

クラス JspFragment

  • public abstract class JspFragment
extends ObjectSE
    JSP フラグメントは、JSP コードの一部をオブジェクトとしてカプセル化したもので、必要に応じて何度でも呼び出すことができます。JSP フラグメントは、JSP の構文を用いて、SimpleTag ハンドラーを呼び出すためのタグの本体として、あるいは、フラグメントとして宣言された属性の値を指定する <jsp:attribute> 標準アクションの本体として、または、TLD で JspFragment 型と宣言された属性の値として定義されます。

    JSP フラグメントの定義には、テンプレートテキストと JSP アクション要素のみを含める必要があります。つまり、スクリプトレットまたはスクリプトレット式を含めることはできません。コンテナーは変換時に、定義されたフラグメントを実行できる JspFragment 抽象クラスの実装を生成します。

    タグハンドラーは、フラグメントを 0 回以上呼び出すか、戻る前に他のタグに渡すことができます。タグハンドラーは、JSP フラグメントとの間で値をやり取りするために、フラグメントに関連付けられた JspContext に値を格納 / 取得します。

    タグライブラリの開発者とページ作成者は、JspFragment 実装を手動で生成しないでください。

    実装ノート : フラグメントごとに個別のクラスを生成する必要はありません。可能な実装の 1 つは、JspFragment を実装するページごとに単一のヘルパークラスを生成することです。構築時に、そのインスタンスを実行するフラグメントを選択するための識別子を渡すことができます。

    導入:
    JSP 2.0

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

      • JspFragment

        public JspFragment()

    • メソッドの詳細

      • invoke

        public abstract void invoke​(WriterSE out)
                     throws JspException,
                            IOExceptionSE
        フラグメントを実行し、すべての出力を指定された Writer に送信します。または、out が null の場合、フラグメントに関連付けられた JspContext の getOut() メソッドによって返された JspWriter に送信します。
        パラメーター:
        out - フラグメントを出力するライター、または出力を JspContext.getOut() に送信する必要がある場合は null。
        例外:
        JspException - このフラグメントの呼び出し中にエラーが発生した場合にスローされます。
        SkipPageException - このフラグメントを呼び出したタグハンドラーを（直接的または間接的に）呼び出したページが評価を停止する場合にスローされます。クラシックタグハンドラーが Tag.SKIP_PAGE を返した場合、またはシンプルタグハンドラーが SkipPageException をスローした場合、コンテナーはこの例外をスローする必要があります。
        IOExceptionSE - ストリームへの書き込み中にエラーが発生した場合。

      • getJspContext

        public abstract JspContext getJspContext()
        この JspFragment にバインドされている JspContext を返します。
        戻り値:
        このフラグメントが呼び出し時に使用する JspContext。