com.ivata.mask.web.tag.util
Class MapEntryTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.ivata.mask.web.tag.util.MapEntryTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class MapEntryTag

extends javax.servlet.jsp.tagext.BodyTagSupport

This tag must always be contained within a MapTag and defines the name and value of an entry in the map.

Tag attributes:

attribute	reqd.	param. class	description
mapName	false	String	If the mapEntry is not inside a map tag, use this attribute to specify a java.util.Map instance in the current page context.
name	true	String	Specifies the name of the entry to put in the parent map.
value	false	String	Specifies the value of the entry with the name speciified. If this attribute is not specified, you should specify a tag body.

Since:

ivata masks 0.5 (2002-01-23)

Version:

$Revision: 1.4 $

Author:

Colin MacLeod colin.macleod@ivata.com

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

MapEntryTag()

Method Summary

int	doAfterBody() This method is called after the JSP engine processes the body content of the tag.
int	doEndTag() This method is called after the JSP engine finished processing the tag.
int	doStartTag() This method is called when the JSP engine encounters the start tag, after the attributes are processed.
java.lang.String	getMapName() If the mapEntry is not inside a map tag, use this attribute to specify a java.util.Map instance in the current page context.
java.lang.String	getName() Specifies the name of the entry to put in the parent map.
java.lang.String	getValue() Specifies the value of the entry to put in the parent map.
void	setMapName(java.lang.String mapNameParam) If the mapEntry is not inside a map tag, use this attribute to specify a java.util.Map instance in the current page context.
void	setName(java.lang.String nameParam) Specifies the name of the entry to put in the parent map.
void	setValue(java.lang.String valueParam) Specifies the value of the entry to put in the parent map.

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

doInitBody, getBodyContent, getPreviousOut, release, 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

MapEntryTag

public MapEntryTag()

Method Detail

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException

This method is called after the JSP engine processes the body content of the tag.

Returns:

SKIP_BODY since we only ever want to evaluate this tag once.

Throws:

javax.servlet.jsp.JspException - encapsulates any exception when calling writeTagBodyContent.

See Also:

#writeTagBodyContent( JspWriter out, BodyContent bodyContent )

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

This method is called after the JSP engine finished processing the tag.

Returns:

EVAL_PAGE since we always want to evaluate the page after this tag.

Throws:

javax.servlet.jsp.JspException - encapsulates any exception when calling out.println

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

This method is called when the JSP engine encounters the start tag, after the attributes are processed.

Scripting variables (if any) have their values set here.

Returns:

EVAL_BODY_BUFFERED if no value was specified, otherwise SKIP_BODY.

Throws:

javax.servlet.jsp.JspException - encapsulates any exception when calling out.println

getMapName

public final java.lang.String getMapName()

If the mapEntry is not inside a map tag, use this attribute to specify a java.util.Map instance in the current page context.

Returns:

the current value of mapName.

getName

public final java.lang.String getName()

Specifies the name of the entry to put in the parent map.

Returns:

the current value of name.

getValue

public final java.lang.String getValue()

Specifies the value of the entry to put in the parent map.

Returns:

the current value of value.

setMapName

public final void setMapName(java.lang.String mapNameParam)

If the mapEntry is not inside a map tag, use this attribute to specify a java.util.Map instance in the current page context.

Parameters:

mapNameParam - the new value of mapName.

setName

public final void setName(java.lang.String nameParam)

Specifies the name of the entry to put in the parent map.

Parameters:

nameParam - the new value of name.

setValue

public final void setValue(java.lang.String valueParam)

Specifies the value of the entry to put in the parent map.

Parameters:

valueParam - the new value of value.