Apache Tomcat 7.0.57
org.apache.tomcat.util.digester

Class CallParamRule

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      protected java.lang.String attributeName
      The attribute from which to save the parameter value
      protected ArrayStack<java.lang.String> bodyTextStack
      Stack is used to allow nested body text to be processed.
      protected boolean fromStack
      Is the parameter to be set from the stack?
      protected int paramIndex
      The zero-relative index of the parameter we are saving.
      protected int stackIndex
      The position of the object from the top of the stack
    • Constructor Summary

      Constructors 
      Constructor and Description
      CallParamRule(int paramIndex)
      Construct a "call parameter" rule that will save the body text of this element as the parameter value.
      CallParamRule(int paramIndex, boolean fromStack)
      Construct a "call parameter" rule.
      CallParamRule(int paramIndex, int stackIndex)
      Constructs a "call parameter" rule which sets a parameter from the stack.
      CallParamRule(int paramIndex, java.lang.String attributeName)
      Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void begin(java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes attributes)
      Process the start of this element.
      void body(java.lang.String namespace, java.lang.String name, java.lang.String bodyText)
      Process the body text of this element.
      void end(java.lang.String namespace, java.lang.String name)
      Process any body texts now.
      java.lang.String toString()
      Render a printable version of this Rule.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • attributeName

        protected java.lang.String attributeName
        The attribute from which to save the parameter value
      • paramIndex

        protected int paramIndex
        The zero-relative index of the parameter we are saving.
      • fromStack

        protected boolean fromStack
        Is the parameter to be set from the stack?
      • stackIndex

        protected int stackIndex
        The position of the object from the top of the stack
      • bodyTextStack

        protected ArrayStack<java.lang.String> bodyTextStack
        Stack is used to allow nested body text to be processed. Lazy creation.
    • Constructor Detail

      • CallParamRule

        public CallParamRule(int paramIndex)
        Construct a "call parameter" rule that will save the body text of this element as the parameter value.
        Parameters:
        paramIndex - The zero-relative parameter number
      • CallParamRule

        public CallParamRule(int paramIndex,
                     java.lang.String attributeName)
        Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
        Parameters:
        paramIndex - The zero-relative parameter number
        attributeName - The name of the attribute to save
      • CallParamRule

        public CallParamRule(int paramIndex,
                     boolean fromStack)
        Construct a "call parameter" rule.
        Parameters:
        paramIndex - The zero-relative parameter number
        fromStack - should this parameter be taken from the top of the stack?
      • CallParamRule

        public CallParamRule(int paramIndex,
                     int stackIndex)
        Constructs a "call parameter" rule which sets a parameter from the stack. If the stack contains too few objects, then the parameter will be set to null.
        Parameters:
        paramIndex - The zero-relative parameter number
        stackIndex - the index of the object which will be passed as a parameter. The zeroth object is the top of the stack, 1 is the next object down and so on.
    • Method Detail

      • begin

        public void begin(java.lang.String namespace,
                 java.lang.String name,
                 org.xml.sax.Attributes attributes)
                   throws java.lang.Exception
        Process the start of this element.
        Overrides:
        begin in class Rule
        Parameters:
        namespace - the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
        name - the local name if the parser is namespace aware, or just the element name otherwise
        attributes - The attribute list for this element
        Throws:
        java.lang.Exception
      • body

        public void body(java.lang.String namespace,
                java.lang.String name,
                java.lang.String bodyText)
                  throws java.lang.Exception
        Process the body text of this element.
        Overrides:
        body in class Rule
        Parameters:
        namespace - the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
        name - the local name if the parser is namespace aware, or just the element name otherwise
        bodyText - The body text of this element
        Throws:
        java.lang.Exception
      • end

        public void end(java.lang.String namespace,
               java.lang.String name)
        Process any body texts now.
        Overrides:
        end in class Rule
        Parameters:
        namespace - the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
        name - the local name if the parser is namespace aware, or just the element name otherwise
      • toString

        public java.lang.String toString()
        Render a printable version of this Rule.
        Overrides:
        toString in class java.lang.Object
Apache Tomcat 7.0.57

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.