Package ubic.gemma.web.taglib

Class ConstantsTag

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
ubic.gemma.web.taglib.ConstantsTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
public class ConstantsTag extends javax.servlet.jsp.tagext.TagSupport

This class is designed to put all the public variables in a class to a specified scope - designed for exposing a Constants class to Tag Libraries.

It is designed to be used as follows: 
 <tag:constants />

Optional values are "className" (fully qualified) and "scope".

View Source
Author:
Matt Raible, originally., pavlidis modified
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
    ConstantsTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doStartTag()
     
    String
    getClassName()
    The class to expose the variables from.
    String
    getScope()
    The scope to be put the variable in.
    int
    getScope(String scopeName)
    Converts the scope name into its corresponding PageContext constant value.
    String
    getVar()
    The single variable to expose.
    void
    release()
    Release all allocated resources.
    void
    setClassName(String className)
    The class to expose the variables from.
    void
    setScope(String scope)
    The scope to be put the variable in.
    void
    setVar(String var)
    The single variable to expose.

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

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

    • ConstantsTag

      public ConstantsTag()

  • Method Details

    • doStartTag

      public 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

    • getScope

      public int getScope(String scopeName) throws javax.servlet.jsp.JspException
      Converts the scope name into its corresponding PageContext constant value.
      Parameters:
      scopeName - Can be "page", "request", "session", or "application" in any case.
      Returns:
      The constant representing the scope (ie. PageContext.REQUEST_SCOPE).
      Throws:
      javax.servlet.jsp.JspException - if the scopeName is not a valid name.

    • release

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

    • setClassName

      public void setClassName(String className)
      The class to expose the variables from.

    • setScope

      public void setScope(@Nullable String scope)
      The scope to be put the variable in.

    • setVar

      public void setVar(@Nullable String var)
      The single variable to expose.

    • getClassName

      public String getClassName()
      The class to expose the variables from.

    • getScope

      @Nullable public String getScope()
      The scope to be put the variable in.

    • getVar

      @Nullable public String getVar()
      The single variable to expose.