Package net.sf.saxon.functions.hof

Class UserFunctionReference.BoundUserFunction

  • All Implemented Interfaces:
    Callable, ContextOriginator, Function, GroundedValue, Item, Sequence
    Enclosing class:
    UserFunctionReference
    public static class UserFunctionReference.BoundUserFunction
extends AbstractFunction
implements ContextOriginator
    A BoundUserFunction represents a user-defined function seen as a component. A single source-level XSLT function may be the actor in several different components (in different stylesheet packages). Although the code of the function is identical in each case, the bindings to other stylesheet components may be different.

    • Method Detail

      • getTargetFunction

        public Function getTargetFunction()

      • getController

        public Controller getController()

      • makeNewContext

        public XPathContext makeNewContext​(XPathContext oldContext,
                                   ContextOriginator originator)
        Description copied from class: AbstractFunction
        Prepare an XPathContext object for evaluating the function
        Specified by:
        makeNewContext in interface Function
        Overrides:
        makeNewContext in class AbstractFunction
        Parameters:
        oldContext - the XPathContext of the function calling expression
        originator - the originator of the new context
        Returns:
        a suitable context for evaluating the function (which may or may not be the same as the caller's context)

      • call

        public Sequence call​(XPathContext context,
                     Sequence[] args)
              throws XPathException
        Description copied from interface: Callable
        Call the Callable.
        Specified by:
        call in interface Callable
        Parameters:
        context - the dynamic evaluation context
        args - the values of the arguments, supplied as Sequences.

        Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

        If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

        It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

        Returns:
        the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.
        Throws:
        XPathException - if a dynamic error occurs during the evaluation of the expression

      • getFunctionName

        public StructuredQName getFunctionName()
        Description copied from interface: Function
        Get the name of the function, or null if it is anonymous
        Specified by:
        getFunctionName in interface Function
        Returns:
        the function name, or null for an anonymous inline function

      • getArity

        public int getArity()
        Description copied from interface: Function
        Get the arity of the function
        Specified by:
        getArity in interface Function
        Returns:
        the number of arguments in the function signature

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Function
        Get a description of this function for use in error messages. For named functions, the description is the function name (as a lexical QName). For others, it might be, for example, "inline function", or "partially-applied ends-with function".
        Specified by:
        getDescription in interface Function
        Returns:
        a description of the function for use in error messages