org.apache.struts.taglib.logic
Class ConditionalTagBase

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.logic.ConditionalTagBase
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
CompareTagBase, EmptyTag, MatchTag, MessagesPresentTag, PresentTag

public abstract class ConditionalTagBase
extends javax.servlet.jsp.tagext.TagSupport

Abstract base class for the various conditional evaluation tags.

Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:
Serialized Form

Field Summary
protected  java.lang.String cookie
          The name of the cookie to be used as a variable.
protected  java.lang.String header
          The name of the HTTP request header to be used as a variable.
protected static MessageResources messages
          The message resources for this package.
protected  java.lang.String name
          The name of the JSP bean to be used as a variable (if property is not specified), or whose property is to be accessed (if property is specified).
protected  java.lang.String parameter
          The name of the HTTP request parameter to be used as a variable.
protected  java.lang.String property
          The name of the bean property to be used as a variable.
protected  java.lang.String role
          The name of the security role to be checked for.
protected  java.lang.String scope
          The scope to search for the bean named by the name property, or "any scope" if null.
protected  java.lang.String user
          The user principal name to be checked for.
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext, parent, values
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
ConditionalTagBase()
           
 
Method Summary
protected abstract  boolean condition()
          Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped.
 int doEndTag()
          Evaluate the remainder of the current page normally.
 int doStartTag()
          Perform the test required for this particular tag, and either evaluate or skip the body of this tag.
 java.lang.String getCookie()
           
 java.lang.String getHeader()
           
 java.lang.String getName()
           
 java.lang.String getParameter()
           
 java.lang.String getProperty()
           
 java.lang.String getRole()
           
 java.lang.String getScope()
           
 java.lang.String getUser()
           
 void release()
          Release all allocated resources.
 void setCookie(java.lang.String cookie)
           
 void setHeader(java.lang.String header)
           
 void setName(java.lang.String name)
           
 void setParameter(java.lang.String parameter)
           
 void setProperty(java.lang.String property)
           
 void setRole(java.lang.String role)
           
 void setScope(java.lang.String scope)
           
 void setUser(java.lang.String user)
           
 
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, registerNatives, toString, wait, wait, wait
 

Field Detail

cookie

protected java.lang.String cookie
The name of the cookie to be used as a variable.

header

protected java.lang.String header
The name of the HTTP request header to be used as a variable.

messages

protected static MessageResources messages
The message resources for this package.

name

protected java.lang.String name
The name of the JSP bean to be used as a variable (if property is not specified), or whose property is to be accessed (if property is specified).

parameter

protected java.lang.String parameter
The name of the HTTP request parameter to be used as a variable.

property

protected java.lang.String property
The name of the bean property to be used as a variable.

role

protected java.lang.String role
The name of the security role to be checked for.

scope

protected java.lang.String scope
The scope to search for the bean named by the name property, or "any scope" if null.

user

protected java.lang.String user
The user principal name to be checked for.
Constructor Detail

ConditionalTagBase

public ConditionalTagBase()
Method Detail

getCookie

public java.lang.String getCookie()

setCookie

public void setCookie(java.lang.String cookie)

getHeader

public java.lang.String getHeader()

setHeader

public void setHeader(java.lang.String header)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getParameter

public java.lang.String getParameter()

setParameter

public void setParameter(java.lang.String parameter)

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getRole

public java.lang.String getRole()

setRole

public void setRole(java.lang.String role)

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String scope)

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String user)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Perform the test required for this particular tag, and either evaluate or skip the body of this tag.
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception occurs

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Evaluate the remainder of the current page normally.
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception occurs

release

public void release()
Release all allocated resources.
Overrides:
release in class javax.servlet.jsp.tagext.TagSupport

condition

protected abstract boolean condition()
                              throws javax.servlet.jsp.JspException
Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped. This method must be implemented by concrete subclasses.
Throws:
javax.servlet.jsp.JspException - if a JSP exception occurs


Copyright 2000-2006 - The Apache Software Foundation