CanonicalLinkTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.content.CanonicalLinkTag

All Implemented Interfaces:: Serializable, IterationTag, JspTag, Tag

public class CanonicalLinkTag extends TagSupport

A JSP tag to generate canonical URLs for a page.

Since:

6.0

Version:

8.2

Author:

Luke

See Also:

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

Constructors

Constructor

Description

CanonicalLinkTag()
Method Summary

Modifier and Type

Method

Description

int

doEndTag()

Writes the canonical link tag to the JSP output stream.

int

doStartTag()

Checks the input parameters and calculates the canonical URL if necessary.

void

release()

Releases the tag's state variables.

void

setConvertID(boolean convertID)

Sets whether to convert numeric ID parameters to hexadecimal.

void

setUrl(String url)

Overrides the canonical URL for this page.

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

Constructor Details
- CanonicalLinkTag
  
  public CanonicalLinkTag()
Method Details
- setUrl
  
  public void setUrl(String url)
  
  Overrides the canonical URL for this page.
  
  Parameters:
  
  url - the URL
- setConvertID
  
  public void setConvertID(boolean convertID)
  
  Sets whether to convert numeric ID parameters to hexadecimal.
  
  Parameters:
  
  convertID - TRUE if parameters should be converted, otherwise FALSE
- release
  
  public void release()
  
  Releases the tag's state variables.
  
  Specified by:
  
  release in interface Tag
  
  Overrides:
  
  release in class TagSupport
- doStartTag
  
  public int doStartTag() throws JspException
  
  Checks the input parameters and calculates the canonical URL if necessary.
  
  Specified by:
  
  doStartTag in interface Tag
  
  Overrides:
  
  doStartTag in class TagSupport
  
  Returns:
  
  SKIP_BODY always
  
  Throws:
  
  JspException - if an error occurs
- doEndTag
  
  public int doEndTag() throws JspException
  
  Writes the canonical link tag to the JSP output stream.
  
  Specified by:
  
  doEndTag in interface Tag
  
  Overrides:
  
  doEndTag in class TagSupport
  
  Returns:
  
  EVAL_BODY always
  
  Throws:
  
  JspException - if an error occurs