Class ContainerInteractionTag
java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
ee.jakarta.tck.pages.api.jakarta_servlet.jsp.tagext.tagsupport.ContainerInteractionTag
- All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag
,jakarta.servlet.jsp.tagext.JspTag
,jakarta.servlet.jsp.tagext.Tag
,Serializable
- Direct Known Subclasses:
BodyContainerInteractionTag
,SynchronizationTag
public class ContainerInteractionTag
extends jakarta.servlet.jsp.tagext.TagSupport
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Return value for doAfterBody().protected String
Return value for doEndTag().protected String
Return value for doStartTag().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 -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addMethodToList
(String methodName) This will add an application scoped List to the page context based of the name (_result).int
Validate container behavior when returning either EVAL_BODY_AGAIN or SKIP_BODY.int
doEndTag()
Validate container behavior when returning either SKIP_PAGE or EVAL_PAGE.int
Validate container behavior when returning either EVAL_BODY_INCLUDE, SKIP_BODY, or SKIP_PAGE.Returns the number of times the body content will be evaluated minus the initial evaluation.Returns the configured value for doAfterBody().Returns the current configured return value for doEndTag().Returns the current configured return value for doStartTag().protected int
getIntValue
(String varName) Utility method to return the int value based on an Integer based PageContext attribute.Gets the name of the application scoped list.void
setBodyCount
(Integer bodyCount) Sets the number of times the body will be evaluated after the initial evaluation.void
setDoAfterBody
(String doAfterBody) Configures the return value for doAfterBody();void
setDoEndTag
(String doEndTag) Configures the return value for doEndTag().void
setDoStartTag
(String doStartTag) Configures the return value for doStartTag().void
Sets the name of the application scoped list.Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
-
Field Details
-
_doStartTag
Return value for doStartTag(). -
_doEndTag
Return value for doEndTag(). -
_doAfterBody
Return value for doAfterBody().
-
-
Constructor Details
-
ContainerInteractionTag
public ContainerInteractionTag()Default constructor.
-
-
Method Details
-
getResult
Gets the name of the application scoped list.- Returns:
- the name of the application scoped list
-
setResult
Sets the name of the application scoped list.- Parameters:
result
- - the name of the list
-
getDoStartTag
Returns the current configured return value for doStartTag().- Returns:
- the current configured return value for doStartTag()
-
setDoStartTag
Configures the return value for doStartTag().- Parameters:
doStartTag
- - the return value
-
getDoEndTag
Returns the current configured return value for doEndTag().- Returns:
- the current configured return value for doEndTag()
-
setDoEndTag
Configures the return value for doEndTag().- Parameters:
doEndTag
- - the return value
-
getBodyCount
Returns the number of times the body content will be evaluated minus the initial evaluation.- Returns:
- the number of times the body content will be evaluated minus the initial evaluation.
-
setBodyCount
Sets the number of times the body will be evaluated after the initial evaluation.- Parameters:
bodyCount
- - the body evaluation count
-
getDoAfterBody
Returns the configured value for doAfterBody().- Returns:
- the current configured value for doAfterBody()
-
setDoAfterBody
Configures the return value for doAfterBody();- Parameters:
doAfterBody
- - the return value for doAfterBody()
-
doStartTag
public int doStartTag() throws jakarta.servlet.jsp.JspExceptionValidate container behavior when returning either EVAL_BODY_INCLUDE, SKIP_BODY, or SKIP_PAGE.- Specified by:
doStartTag
in interfacejakarta.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjakarta.servlet.jsp.tagext.TagSupport
- Returns:
- an int value based on the doStartTag attribute.
- Throws:
jakarta.servlet.jsp.JspException
- if an error occurs
-
doEndTag
public int doEndTag() throws jakarta.servlet.jsp.JspExceptionValidate container behavior when returning either SKIP_PAGE or EVAL_PAGE.- Specified by:
doEndTag
in interfacejakarta.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjakarta.servlet.jsp.tagext.TagSupport
- Returns:
- an int value based on the doEndTag attribute.
- Throws:
jakarta.servlet.jsp.JspException
- if an error occurs
-
doAfterBody
public int doAfterBody() throws jakarta.servlet.jsp.JspExceptionValidate container behavior when returning either EVAL_BODY_AGAIN or SKIP_BODY.- Specified by:
doAfterBody
in interfacejakarta.servlet.jsp.tagext.IterationTag
- Overrides:
doAfterBody
in classjakarta.servlet.jsp.tagext.TagSupport
- Returns:
- an int value based on the doAfterBody attribute.
- Throws:
jakarta.servlet.jsp.JspException
- - if an error occurs.
-
addMethodToList
This will add an application scoped List to the page context based of the name (_result). The list contains the methods called against this tag handler by the container.- Parameters:
methodName
- - the method name to add to the list.
-
getIntValue
Utility method to return the int value based on an Integer based PageContext attribute.- Parameters:
varName
- - the PageContext attribute to retrieve the int value from- Returns:
- an int representation of the Integer attribute
-