org.apache.commons.digester3

Class CallParamRule

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      protected String attributeName
      The attribute from which to save the parameter value
      protected Stack<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, String attributeName)
      Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
    • Field Detail

      • attributeName

        protected 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 Stack<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.

        Note that if the element is empty the an empty string is passed to the target method, not null. And if automatic type conversion is being applied (ie if the target function takes something other than a string as a parameter) then the conversion will fail if the converter class does not accept an empty string as valid input.

        Parameters:
        paramIndex - The zero-relative parameter number
      • CallParamRule

        public CallParamRule(int paramIndex,
                     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

      • setAttributeName

        public void setAttributeName(String attributeName)
        Set the attribute from which to save the parameter value.
        Parameters:
        attributeName - The attribute from which to save the parameter value
        Since:
        3.0
      • begin

        public void begin(String namespace,
                 String name,
                 Attributes attributes)
                   throws Exception
        This method is called when the beginning of a matching XML element is encountered.
        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 of this element
        Throws:
        Exception - if any error occurs
      • body

        public void body(String namespace,
                String name,
                String text)
                  throws Exception
        This method is called when the body of a matching XML element is encountered. If the element has no body, this method is called with an empty string as the body text.
        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
        text - The text of the body of this element
        Throws:
        Exception - if any error occurs
      • end

        public void end(String namespace,
               String name)
        This method is called when the end of a matching XML element is encountered.
        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

Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.