org.apache.taglibs.request
Class EqualsCookieTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byorg.apache.taglibs.request.EqualsCookieTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

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

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

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

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

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

JSP Tag Lib Descriptor

 <name>equalsCookie</name>
 <tagclass>org.apache.taglibs.request.EqualsCookieTag</tagclass>
 <bodycontent>JSP</bodycontent>
 <info>Includes the body of the tag if the request cookie equals the
 value of the "match" tag cookie.</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
EqualsCookieTag()
           
 
Method Summary
 int doStartTag()
          Includes the body of the tag if the request cookie equals the value set in the 'match' cookie.
 void setIgnoreCase(boolean value)
          If ignoreCase is set to true, then the comparison between the "match" attribute and the request cookie will not be case sensitive
 void setMatch(java.lang.String str)
          Set the String that will be compared to the request cookie.
 void setName(java.lang.String str)
          Set the required tag cookie name.
 void setValue(boolean value)
          Set the optional tag cookie 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

EqualsCookieTag

public EqualsCookieTag()
Method Detail

doStartTag

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

Returns:
SKIP_BODY if equalsCookie body content does not equal the value of the match cookie, EVAL_BODY_include if it does
Throws:
javax.servlet.jsp.JspException

setName

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


setMatch

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


setIgnoreCase

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


setValue

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



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