javax.servlet.jsp.tagext
クラス BodyContent

java.lang.Object
  |
  +--java.io.Writer
        |
        +--javax.servlet.jsp.JspWriter
              |
              +--javax.servlet.jsp.tagext.BodyContent

public abstract class BodyContent

extends JspWriter

タグハンドラに渡せるよう、アクションボディの評価をカプセル化したものです。 BodyContentはJspWriterのサブクラスです。

BodyContentのコンテンツは評価の結果であるため、アクションやその他のものを含みませんが、それらの実行結果であることに注意して下さい。

BocyContentには、コンテンツをStringに変換する、コンテンツを読む、コンテンツをクリアするといったメソッドがあります。

BodyContentオブジェクトのバッファサイズは、無制限です。 BodyContentオブジェクトは自動フラッシュモードをサポートしません。 裏にあるストリームがないため、BodyContentオブジェクトのflushを実行することはできません。

BodyContentのインスタンスは、PageContextクラスのpushBodyやpopBodyメソッドを実行することによって作成されます。 BodyContentは、関連したアクションの構造にしたがった別のJspWriter(おそらくもうひとつのBodyContentオブジェクト)を内包します。

setBodyContent()を呼ぶことで、BodyTag から BodyContentが見えるようになります。 またタグハンドラは、doEndTag()への呼び出しが終わるまでオブジェクトを使用することができます。

フィールドの概要

クラス javax.servlet.jsp.JspWriter から継承したフィールド

autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER

クラス java.io.Writer から継承したフィールド

lock

コンストラクタの概要

protected

BodyContent(JspWriter e) Protectedのコンストラクタ。

メソッドの概要

void	clearBody() 例外をスローせずにボディをクリアします。
void	flush() flush()を再定義します。
JspWriter	getEnclosingWriter() 内包しているJspWriterを取得します。
abstract Reader	getReader() BodyContentの値をReaderとして返します。
abstract String	getString() BodyContentの値をStringとして返します。
abstract void	writeOut(Writer out) Writerを通してこのBodyContentの内容を書き込みます。

クラス javax.servlet.jsp.JspWriter から継承したメソッド

clear, clearBuffer, close, getBufferSize, getRemaining, isAutoFlush, newLine, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println

クラス java.io.Writer から継承したメソッド

write, write, write, write, write

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

BodyContent

protected BodyContent(JspWriter e)

Protectedのコンストラクタ。 制限なしバッファ、自動フラッシュしません。

メソッドの詳細

flush

public void flush()
           throws IOException

flush()を再定義します。このメソッドの使用は推奨されません。

裏にあるストリームを利用できないため、BodyContentのフラッシュは有効ではありません。

定義:

クラス JspWriter 内の flush

例外:

IOException - I/Oエラーが発生した場合

clearBody

public void clearBody()

例外をスローせずにボディをクリアします。

getReader

public abstract Reader getReader()

BodyContentの値をReaderとして返します。

戻り値:

ReaderのBodyContentの値

getString

public abstract String getString()

BodyContentの値をStringとして返します。

戻り値:

StringのBodyContentの値

writeOut

public abstract void writeOut(Writer out)
                       throws IOException

Writerを通してこのBodyContentの内容を書き込みます。 サブクラスは共通の起動パターンを最適化するかもしれません。

パラメータ:

out - ボディ評価の内容を保持するWriter

IOException

getEnclosingWriter

public JspWriter getEnclosingWriter()

内包しているJspWriterを取得します。

戻り値:

構築時に渡された内包しているJspWriter