javawebparts.taglib.basicstr
Class ReplaceTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport
              |
              +--javawebparts.taglib.basicstr.ReplaceTag

All Implemented Interfaces:

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

public class ReplaceTag

extends javax.servlet.jsp.tagext.BodyTagSupport

This class is a custom tag that replaces substrings within a string.

This tag uses the following attributes:

match - This is the string to find within the text
replaceWidth - As the name implies, any occurances of the string defined by the match parameter will be replaced in the text

Author:

Frank W. Zammetti.

See Also:

Serialized Form

Field Summary

private static org.apache.commons.logging.Log	log Log instance.
private java.lang.String	match This is the attribute that defines the substring to search for.
private java.lang.String	replaceWith This is the attribute that defines what to replace substring with.
private java.lang.String	text This is the body content text to be altered.

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

ReplaceTag()

Method Summary

int	doAfterBody() Alter the body content.
int	doEndTag() Render the altered body.
void	setMatch(java.lang.String inMatch) match mutator.
void	setReplaceWith(java.lang.String inReplaceWith) replaceWith mutator.

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

doInitBody, doStartTag, 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

Field Detail

log

private static org.apache.commons.logging.Log log

Log instance.

text

private java.lang.String text

This is the body content text to be altered.

match

private java.lang.String match

This is the attribute that defines the substring to search for.

replaceWith

private java.lang.String replaceWith

This is the attribute that defines what to replace substring with.

Constructor Detail

ReplaceTag

public ReplaceTag()

Method Detail

setMatch

public void setMatch(java.lang.String inMatch)

match mutator.

Parameters:

inMatch - match string.

setReplaceWith

public void setReplaceWith(java.lang.String inReplaceWith)

replaceWith mutator.

Parameters:

inReplaceWith - replaceWith string.

doAfterBody

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

Alter the body content.

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

Return code.

Throws:

javax.servlet.jsp.JspException - If anything goes wrong.

doEndTag

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

Render the altered body.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

Return code.

Throws:

javax.servlet.jsp.JspException - If anything goes wrong.