Package net.ontopia.topicmaps.nav2.taglibs.tolog

Class BaseOutputProducingTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
net.ontopia.topicmaps.nav2.taglibs.tolog.BaseOutputProducingTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
Direct Known Subclasses:
ObjectIdTag, OutTag, SymbolicIdTag
public abstract class BaseOutputProducingTag extends jakarta.servlet.jsp.tagext.TagSupport
INTERNAL: Abstract super-class of an Output-Producing Tag.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    escapeEntities
     
    protected String
    fallbackValue
     
    protected String
    query
     
    protected String
    variableName
     

    Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

    id, pageContext

    Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

    EVAL_BODY_AGAIN

    Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    BaseOutputProducingTag()
     
    protected
    BaseOutputProducingTag(boolean escapeEntities)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final int
    doEndTag()
     
    int
    doStartTag()
    Process the start tag for this instance.
    abstract void
    generateOutput(jakarta.servlet.jsp.JspWriter out, Object outObject)
     
    Object
    generateOutputObject()
    Get the object to write out (either through a variable or query).
    protected abstract String
    getName()
     
    protected final void
    print2Writer(jakarta.servlet.jsp.JspWriter out, String string)
    INTERNAL: prints out string to specified JspWriter object with respect if the entities should be escaped.
    void
    release()
    reset the state of the Tag.
    final void
    setFallback(String fallbackValue)
     
    void
    setQuery(String query)
     
    final void
    setVar(String variableName)
     

    Methods inherited from class jakarta.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 Details

    • escapeEntities

      protected boolean escapeEntities

    • variableName

      protected String variableName

    • query

      protected String query

    • fallbackValue

      protected String fallbackValue

  • Constructor Details

    • BaseOutputProducingTag

      public BaseOutputProducingTag()

    • BaseOutputProducingTag

      protected BaseOutputProducingTag(boolean escapeEntities)

  • Method Details

    • getName

      protected abstract String getName()

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspTagException
      Process the start tag for this instance.
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Throws:
      jakarta.servlet.jsp.JspTagException

    • doEndTag

      public final int doEndTag()
      Specified by:
      doEndTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class jakarta.servlet.jsp.tagext.TagSupport

    • release

      public void release()
      reset the state of the Tag.
      Specified by:
      release in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      release in class jakarta.servlet.jsp.tagext.TagSupport

    • generateOutput

      public abstract void generateOutput(jakarta.servlet.jsp.JspWriter out, Object outObject) throws jakarta.servlet.jsp.JspTagException, IOException
      Throws:
      jakarta.servlet.jsp.JspTagException
      IOException

    • generateOutputObject

      public Object generateOutputObject() throws jakarta.servlet.jsp.JspTagException
      Get the object to write out (either through a variable or query).
      Throws:
      jakarta.servlet.jsp.JspTagException

    • setQuery

      public void setQuery(String query)

    • setVar

      public final void setVar(String variableName)

    • setFallback

      public final void setFallback(String fallbackValue)

    • print2Writer

      protected final void print2Writer(jakarta.servlet.jsp.JspWriter out, String string) throws IOException
      INTERNAL: prints out string to specified JspWriter object with respect if the entities should be escaped.
      Throws:
      IOException