org.apache.taglibs.request
Class EqualsParameterTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.apache.taglibs.request.EqualsParameterTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public class EqualsParameterTag
extends javax.servlet.jsp.tagext.TagSupport

JSP Tag equalsParameter, used to determine if a Request parameter equals the value of the "match" tag attribute.

Includes the body of the tag if the parameter equals the value of the "match" tag parameter.

You can set the optional tag parameter value to true or false. The body of the tag is included if equalsParameter matches the value.

You can set the optional tag parameter ignoreCase to true or false. If ignoreCase is set to true, then the comparison between the request parameter and the "match" tag attribute will not be case-sensitive.

JSP Tag Lib Descriptor

 <name>equalsParameter</name>
 <tagclass>org.apache.taglibs.request.EqualsParameterTag</tagclass>
 <bodycontent>JSP</bodycontent>
 <info>Includes the body of the tag if the request parameter equals the
 value of the "match" tag parameter.</info>
   <attribute>
     <name>name</name>
     <required>true</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>value</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>match</name>
     <required>true</required>
     <rtexprvalue>true</rtexprvalue>
   </attribute>
   <attribute>
     <name>ignoreCase</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
 

Author:
Glenn Nielsen
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
EqualsParameterTag()
           
 
Method Summary
 int doStartTag()
          Includes the body of the tag if the request parameter equals the value set in the 'match' parameter.
 void setIgnoreCase(boolean value)
          If ignoreCase is set to true, then the comparison between the "match" attribute and the request parameter will not be case sensitive
 void setMatch(java.lang.String str)
          Set the String that will be compared to the request parameter.
 void setName(java.lang.String str)
          Set the required tag parameter name.
 void setValue(boolean value)
          Set the optional tag parameter value to true or false.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EqualsParameterTag

public EqualsParameterTag()
Method Detail

doStartTag

public final int doStartTag()
                     throws javax.servlet.jsp.JspException
Includes the body of the tag if the request parameter equals the value set in the 'match' parameter.

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Returns:
SKIP_BODY if equalsParameter body content does not equal the value of the match parameter, EVAL_BODY_include if it does
Throws:
javax.servlet.jsp.JspException

setName

public final void setName(java.lang.String str)
Set the required tag parameter name.

Parameters:
String - name of request parameter

setMatch

public final void setMatch(java.lang.String str)
Set the String that will be compared to the request parameter.

Parameters:
String - value to match against the request parameter

setIgnoreCase

public final void setIgnoreCase(boolean value)
If ignoreCase is set to true, then the comparison between the "match" attribute and the request parameter will not be case sensitive

Parameters:
boolean - true = ignore case
false = case sensitive
default value = false

setValue

public final void setValue(boolean value)
Set the optional tag parameter value to true or false.

Parameters:
boolean - true or false


Copyright ? 2000-2004 The Apache Software Foundation. All Rights Reserved.