org.apache.pluto.tags
Class BaseURLTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.pluto.tags.BaseURLTag

All Implemented Interfaces:

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

Direct Known Subclasses:

PortletURLTag, ResourceURLTag

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

Abstract supporting class for actionURL tag, renderURL tag and resourceURL tag.

Version:

2.0

See Also:

Serialized Form

Nested Class Summary

static class

BaseURLTag.TEI TagExtraInfo class for BaseUrlTag.

Field Summary

protected java.lang.Boolean	escapeXml
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	parametersMap
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	propertiesMap
protected java.lang.String	secure
protected java.lang.Boolean	secureBoolean
protected java.lang.String	var

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

BaseURLTag()

Method Summary

protected void	addParameter(java.lang.String key, java.lang.String value) Adds a key,value pair to the parameter map.
protected void	addProperty(java.lang.String key, java.lang.String value) Adds a key,value pair to the property map.
abstract int	doEndTag()
protected java.lang.String	doEscapeXml(java.lang.String str) Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.
abstract int	doStartTag()
java.lang.Boolean	getEscapeXml() Returns escapeXml property.
java.lang.String	getSecure() Returns secure property as String.
boolean	getSecureBoolean() Returns secure property as Boolean.
java.lang.String	getVar() Returns the var property.
void	release()
void	setEscapeXml(java.lang.Boolean escapeXml) Sets the escapeXml property.
void	setSecure(java.lang.String secure) Sets secure property to boolean value of the string.
protected void	setUrlParameters(BaseURL url) Copies the parameters from map to the BaseURL.
protected void	setUrlProperties(BaseURL url) Copies the properties from map to the BaseURL.
void	setVar(java.lang.String var) Sets the var property.

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

doAfterBody, 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

Field Detail

secure

protected java.lang.String secure

secureBoolean

protected java.lang.Boolean secureBoolean

var

protected java.lang.String var

escapeXml

protected java.lang.Boolean escapeXml

parametersMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> parametersMap

propertiesMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> propertiesMap

Constructor Detail

BaseURLTag

public BaseURLTag()

Method Detail

doStartTag

public abstract int doStartTag()
                        throws javax.servlet.jsp.JspException

Specified by:

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

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Specified by:

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

Overrides:

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

Throws:

javax.servlet.jsp.JspException

release

public void release()

Specified by:

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

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport

getSecure

public java.lang.String getSecure()

Returns secure property as String.

Returns:

String

getSecureBoolean

public boolean getSecureBoolean()

Returns secure property as Boolean.

Returns:

boolean

getVar

public java.lang.String getVar()

Returns the var property.

Returns:

String

getEscapeXml

public java.lang.Boolean getEscapeXml()

Returns escapeXml property.

Returns:

Boolean

setSecure

public void setSecure(java.lang.String secure)

Sets secure property to boolean value of the string.

Parameters:

secure -

setVar

public void setVar(java.lang.String var)

Sets the var property.

Parameters:

var - The var to set

setEscapeXml

public void setEscapeXml(java.lang.Boolean escapeXml)

Sets the escapeXml property.

Parameters:

escapeXml -

addParameter

protected void addParameter(java.lang.String key,
                            java.lang.String value)

Adds a key,value pair to the parameter map.

Parameters:

key - String

value - String

addProperty

protected void addProperty(java.lang.String key,
                           java.lang.String value)

Adds a key,value pair to the property map.

Parameters:

key - String

value - String

setUrlParameters

protected void setUrlParameters(BaseURL url)

Copies the parameters from map to the BaseURL.

Parameters:

url - BaseURL

setUrlProperties

protected void setUrlProperties(BaseURL url)

Copies the properties from map to the BaseURL.

Parameters:

url - BaseURL

doEscapeXml

protected java.lang.String doEscapeXml(java.lang.String str)

Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.

Parameters:

str - - the String where to replace

Returns:

String