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

Class ForTokensSupport

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

jakarta.servlet.jsp.jstl.core.LoopTagSupport

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

All Implemented Interfaces:

LoopTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable

Direct Known Subclasses:

ForTokensTag, ForTokensTag

public abstract class ForTokensSupport
extends LoopTagSupport

Support for tag handlers for <forTokens>, the tokenizing iteration tag in JSTL 1.0. This class extends LoopTagSupport and provides ForTokens-specific functionality. The rtexprvalue and expression-evaluating libraries each have handlers that extend this class.

Author:

Shawn Bayern

See Also:

• LoopTagSupport
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	delims
protected Object	items
protected StringTokenizer	st

Fields inherited from class jakarta.servlet.jsp.jstl.core.LoopTagSupport

begin, beginSpecified, deferredExpression, end, endSpecified, itemId, statusId, step, stepSpecified

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

id, pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
ForTokensSupport()

Method Summary

Modifier and Type	Method	Description
protected String	getDelims()
protected boolean	hasNext()	Returns information concerning the availability of more items over which to iterate.
protected Object	next()	Returns the next object over which the tag should iterate.
protected void	prepare()	Prepares for a single tag invocation.
void	release()	Releases any resources this LoopTagSupport may have (or inherit).

Methods inherited from class jakarta.servlet.jsp.jstl.core.LoopTagSupport

doAfterBody, doCatch, doFinally, doStartTag, getCurrent, getLoopStatus, setVar, setVarStatus, validateBegin, validateEnd, validateStep

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

doEndTag, 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 jakarta.servlet.jsp.tagext.Tag

doEndTag, getParent, setPageContext, setParent

Field Details

items

protected Object items

delims

protected String delims

st

protected StringTokenizer st

Constructor Details

ForTokensSupport

public ForTokensSupport()

Method Details

prepare

protected void prepare()
                throws JspTagException

Description copied from class: LoopTagSupport

Prepares for a single tag invocation. Specifically, allows subclasses to prepare for calls to hasNext() and next(). Subclasses can assume that prepare() will be called once for each invocation of doStartTag() in the superclass.

Specified by:

prepare in class LoopTagSupport

Throws:

JspTagException - thrown on error

hasNext

protected boolean hasNext()
                   throws JspTagException

Description copied from class: LoopTagSupport

Returns information concerning the availability of more items over which to iterate. This method must be provided by concrete subclasses of LoopTagSupport to assist the iterative logic provided by the supporting base class.

See next for more information about the purpose and expectations behind this tag.

Specified by:

hasNext in class LoopTagSupport

Returns:

true if there is at least one more item to iterate over, false otherwise

Throws:

JspTagException - thrown on error

See Also:

• LoopTagSupport.next()

next

protected Object next()
               throws JspTagException

Description copied from class: LoopTagSupport

Returns the next object over which the tag should iterate. This method must be provided by concrete subclasses of LoopTagSupport to inform the base logic about what objects it should iterate over.

It is expected that this method will generally be backed by an Iterator, but this will not always be the case. In particular, if retrieving the next object raises the possibility of an exception being thrown, this method allows that exception to propagate back to the JSP container as a JspTagException; a standalone Iterator would not be able to do this. (This explains why LoopTagSupport does not simply call for an Iterator from its subtags.)

Specified by:

next in class LoopTagSupport

Returns:

the java.lang.Object to use in the next round of iteration

Throws:

JspTagException - for other, unexpected exceptions

getDelims

protected String getDelims()

Overrides:

getDelims in class LoopTagSupport

release

public void release()

Description copied from class: LoopTagSupport

Releases any resources this LoopTagSupport may have (or inherit).

Specified by:

release in interface Tag

Overrides:

release in class LoopTagSupport

See Also:

• Tag.release()