Ja-Jakarta
Translation

javax.servlet.jsp.tagext
クラス BodyContent

java.lang.Object
  上位を拡張 java.io.Writer
      上位を拡張 javax.servlet.jsp.JspWriter
          上位を拡張 javax.servlet.jsp.tagext.BodyContent
すべての実装されたインタフェース:
java.io.Closeable, java.io.Flushable, java.lang.Appendable

public abstract class BodyContent
extends javax.servlet.jsp.JspWriter

An encapsulation of the evaluation of the body of an action so it is available to a tag handler. BodyContent is a subclass of JspWriter.

Note that the content of BodyContent is the result of evaluation, so it will not contain actions and the like, but the result of their invocation.

BodyContent has methods to convert its contents into a String, to read its contents, and to clear the contents.

The buffer size of a BodyContent object is unbounded. A BodyContent object cannot be in autoFlush mode. It is not possible to invoke flush on a BodyContent object, as there is no backing stream.

Instances of BodyContent are created by invoking the pushBody and popBody methods of the PageContext class. A BodyContent is enclosed within another JspWriter (maybe another BodyContent object) following the structure of their associated actions.

A BodyContent is made available to a BodyTag through a setBodyContent() call. The tag handler can use the object until after the call to doEndTag().


フィールドの概要
 
クラス javax.servlet.jsp.JspWriter から継承されたフィールド
autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER
 
クラス java.io.Writer から継承されたフィールド
lock
 
コンストラクタの概要
protected BodyContent(javax.servlet.jsp.JspWriter e)
          Protected constructor.
 
メソッドの概要
 void clearBody()
          Clear the body without throwing any exceptions.
 void flush()
          Redefined flush() so it is not legal.
 javax.servlet.jsp.JspWriter getEnclosingWriter()
          Get the enclosing JspWriter.
abstract  java.io.Reader getReader()
          Return the value of this BodyContent as a Reader.
abstract  java.lang.String getString()
          Return the value of the BodyContent as a String.
abstract  void writeOut(java.io.Writer out)
          Write the contents of this BodyContent into a Writer.
 
クラス 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 から継承されたメソッド
append, append, append, write, write, write, write, write
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

BodyContent

protected BodyContent(javax.servlet.jsp.JspWriter e)
Protected constructor. Unbounded buffer, no autoflushing.

パラメータ:
e - the enclosing JspWriter
メソッドの詳細

flush

public void flush()
           throws java.io.IOException
Redefined flush() so it is not legal.

It is not valid to flush a BodyContent because there is no backing stream behind it.

定義:
インタフェース java.io.Flushable 内の flush
定義:
クラス javax.servlet.jsp.JspWriter 内の flush
例外:
java.io.IOException - always thrown

clearBody

public void clearBody()
Clear the body without throwing any exceptions.


getReader

public abstract java.io.Reader getReader()
Return the value of this BodyContent as a Reader.

戻り値:
the value of this BodyContent as a Reader

getString

public abstract java.lang.String getString()
Return the value of the BodyContent as a String.

戻り値:
the value of the BodyContent as a String

writeOut

public abstract void writeOut(java.io.Writer out)
                       throws java.io.IOException
Write the contents of this BodyContent into a Writer. Subclasses may optimize common invocation patterns.

パラメータ:
out - The writer into which to place the contents of this body evaluation
例外:
java.io.IOException - if an I/O error occurred while writing the contents of this BodyContent to the given Writer

getEnclosingWriter

public javax.servlet.jsp.JspWriter getEnclosingWriter()
Get the enclosing JspWriter.

戻り値:
the enclosing JspWriter passed at construction time

Ja-Jakarta
Translation

Copyright © 2000- The Apache Software Foundation. All rights Reserved.