com.saxonica.functions.hof

Class UserFunctionReference.BoundUserFunction

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

com.saxonica.functions.hof.UserFunctionReference.BoundUserFunction

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

Enclosing class:

UserFunctionReference

public static class UserFunctionReference.BoundUserFunction
extends AbstractFunction

Constructor Summary

Constructors

Constructor and Description
UserFunctionReference.BoundUserFunction(Component<UserFunction> component)

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] args) Invoke the function
int	getArity() Get the arity of the function
String	getDescription() Get a description of this function for use in error messages.
FunctionItemType	getFunctionItemType() Get the item type of the function item
StructuredQName	getFunctionName() Get the name of the function, or null if it is anonymous

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, export, getOperandRoles, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.Function

iterate

Methods inherited from interface net.sf.saxon.om.Item

head

Methods inherited from interface net.sf.saxon.om.GroundedValue

getLength, head, itemAt, reduce, subsequence

Constructor Detail

UserFunctionReference.BoundUserFunction

public UserFunctionReference.BoundUserFunction(Component<UserFunction> component)

Method Detail

call

public Sequence call(XPathContext context,
            Sequence[] args)
              throws XPathException

Description copied from interface: Function

Invoke the function

Parameters:

context - the XPath dynamic evaluation context

args - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function

getFunctionItemType

public FunctionItemType getFunctionItemType()

Description copied from interface: Function

Get the item type of the function item

Returns:

the function item's type

getFunctionName

public StructuredQName getFunctionName()

Description copied from interface: Function

Get the name of the function, or null if it is anonymous

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

Returns:

the number of arguments in the function signature

getDescription

public 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".

Returns:

a description of the function for use in error messages