Apache Struts API Documentation: Class MatchTag

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.taglib.logic Class MatchTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.logic.ConditionalTagBase
              |
              +--org.apache.struts.taglib.logic.MatchTag

All Implemented Interfaces:: java.io.Serializable, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:: NestedMatchTag, NotMatchTag

public class MatchTag
extends ConditionalTagBase

Evalute the nested body content of this tag if the specified value is a substring of the specified variable.

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`	`location` The location where the match must exist (`start` or `end`), or `null` for anywhere.
`protected java.lang.String`	`value` The value to which the variable specified by other attributes of this tag will be matched.

Fields inherited from class org.apache.struts.taglib.logic.ConditionalTagBase

cookie, header, messages, name, parameter, property, role, scope, user

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
`MatchTag()`

Method Summary
`protected 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.
`protected boolean`	`condition(boolean desired)` 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.
`java.lang.String`	`getLocation()`
`java.lang.String`	`getValue()`
`void`	`release()` Release all allocated resources.
`void`	`setLocation(java.lang.String location)`
`void`	`setValue(java.lang.String value)`

Methods inherited from class org.apache.struts.taglib.logic.ConditionalTagBase

doEndTag, doStartTag, getCookie, getHeader, getName, getParameter, getProperty, getRole, getScope, getUser, setCookie, setHeader, setName, setParameter, setProperty, setRole, setScope, setUser

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

location

protected java.lang.String location

The location where the match must exist (start or end), or null for anywhere.

value

protected java.lang.String value

The value to which the variable specified by other attributes of this tag will be matched.

Constructor Detail

MatchTag

public MatchTag()

Method Detail

getLocation

public java.lang.String getLocation()

setLocation

public void setLocation(java.lang.String location)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

release

public void release()

Release all allocated resources.

Overrides:: release in class ConditionalTagBase

condition

protected 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.

Overrides:: condition in class ConditionalTagBase

Throws:: javax.servlet.jsp.JspException - if a JSP exception occurs