Class XPathFunction

  • Direct Known Subclasses:
    XSLTFunction

    public abstract class XPathFunction
    extends java.lang.Object
    Abstract class representing an XPath function.
    Author:
    Keith Visco, Assaf Arkin
    • Constructor Detail

      • XPathFunction

        public XPathFunction()
    • Method Detail

      • call

        public abstract XPathResult call​(XPathContext context,
                                         XPathResult[] args)
                                  throws XPathException
        Invokes the function and returns the XPath result.
        Parameters:
        context - The XPath context
        params - A list of zero or more arguments
        Returns:
        An XPath result (not null)
        Throws:
        XPathException - if an error occured while invoking this function
      • call

        public XPathResult call​(XPathContext context,
                                XPathResult[] args,
                                FunctionState state)
                         throws XPathException
        Invokes the function and returns the XPath result.
        Parameters:
        context - The XPath context
        params - A list of zero or more arguments
        state - the FunctionState for obtaining additional information about the Function call, such as the actual parameter expressions.
        Returns:
        An XPath result (not null)
        Throws:
        XPathException - if an error occured while invoking this function
      • getNamespaceURI

        public abstract java.lang.String getNamespaceURI()
        Returns the namespace URI of this function.
        Returns:
        The namespace URI of this function
      • getFunctionName

        public abstract java.lang.String getFunctionName()
        Returns the name of this function.
        Returns:
        The name of this function