org.apache.taglibs.standard.tag.common.core

Class OutSupport

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.apache.taglibs.standard.tag.common.core.OutSupport

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, JspTag, Tag

Direct Known Subclasses:

OutTag, OutTag

public abstract class OutSupport
extends BodyTagSupport

Support for handlers of the <out> tag, which simply evalutes and prints the result of the expression it's passed. If the result is null, we print the value of the 'default' attribute's expression or our body (which two are mutually exclusive, although this constraint is enforced outside this handler, in our TagLibraryValidator).

Author:

Shawn Bayern

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
OutSupport() Constructs a new handler.

Method Summary

Modifier and Type	Method and Description
int	doAfterBody() After the body evaluation: do not reevaluate and continue with the page.
int	doEndTag() Default processing of the end tag returning EVAL_PAGE.
int	doStartTag() Default processing of the start tag returning EVAL_BODY_BUFFERED.
protected abstract String	evalDefault() Evaluates the "default" attribute.
protected abstract boolean	evalEscapeXml() Evaluates the "escapeXml" attribute.
protected abstract Object	evalValue() Evaluates the "value" attribute.
void	release() Release state.

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

OutSupport

public OutSupport()

Constructs a new handler. As with TagSupport, subclasses should not provide other constructors and are expected to call the superclass constructor.

Method Detail

release

public void release()

Description copied from class: BodyTagSupport

Release state.

Specified by:

release in interface Tag

Overrides:

release in class BodyTagSupport

See Also:

Tag.release()

doStartTag

public int doStartTag()
               throws JspException

Description copied from class: BodyTagSupport

Default processing of the start tag returning EVAL_BODY_BUFFERED.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Returns:

EVAL_BODY_BUFFERED

Throws:

JspException - if an error occurred while processing this tag

See Also:

Tag.doStartTag()

evalValue

protected abstract Object evalValue()
                             throws JspException

Evaluates the "value" attribute.

Returns:

the actual value of the "value" attribute

Throws:

JspException - if there was a problem evaluating the expression

evalDefault

protected abstract String evalDefault()
                               throws JspException

Evaluates the "default" attribute.

Returns:

the actual value of the "default" attribute

Throws:

JspException - if there was a problem evaluating the expression

evalEscapeXml

protected abstract boolean evalEscapeXml()
                                  throws JspException

Evaluates the "escapeXml" attribute.

Returns:

the actual value of the "escapeXml" attribute

Throws:

JspException - if there was a problem evaluating the expression

doAfterBody

public int doAfterBody()
                throws JspException

Description copied from class: BodyTagSupport

After the body evaluation: do not reevaluate and continue with the page. By default nothing is done with the bodyContent data (if any).

Specified by:

doAfterBody in interface IterationTag

Overrides:

doAfterBody in class BodyTagSupport

Returns:

SKIP_BODY

Throws:

JspException - if an error occurred while processing this tag

See Also:

BodyTagSupport.doInitBody(), IterationTag.doAfterBody()

doEndTag

public int doEndTag()
             throws JspException

Description copied from class: BodyTagSupport

Default processing of the end tag returning EVAL_PAGE.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Returns:

EVAL_PAGE

Throws:

JspException - if an error occurred while processing this tag

See Also:

Tag.doEndTag()