Package net.sf.saxon.functions
Class CallableFunction
java.lang.Object
net.sf.saxon.functions.AbstractFunction
net.sf.saxon.functions.CallableFunction
- All Implemented Interfaces:
Callable
,FunctionItem
,GroundedValue
,Item
,Sequence
A function item that wraps a Callable
-
Constructor Summary
ConstructorsConstructorDescriptionCallableFunction
(int arity, Callable callable, FunctionItemType type) CallableFunction
(SymbolicName.F name, Callable callable, FunctionItemType type) -
Method Summary
Modifier and TypeMethodDescriptioncall
(XPathContext context, Sequence[] args) Invoke the functionvoid
Output information about this function item to the diagnostic explain() outputGet the function annotations (as defined in XQuery).int
getArity()
Get the arity of the functionGet a description of this function for use in error messages.Get the item type of the function itemGet the name of the function, or null if it is anonymousvoid
setAnnotations
(AnnotationList annotations) void
setCallable
(Callable callable) void
setType
(FunctionItemType type) Methods inherited from class net.sf.saxon.functions.AbstractFunction
atomize, deepEqual40, deepEquals, effectiveBooleanValue, getOperandRoles, getUnicodeStringValue, isArray, isMap, isTrustedResultType, makeNewContext, simplify, toShortString, typeCheck
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.FunctionItem
getGenre, isSequenceVariadic
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
CallableFunction
-
CallableFunction
-
-
Method Details
-
getCallable
-
setCallable
-
setType
-
getFunctionItemType
Get the item type of the function item- Returns:
- the function item's type
-
getFunctionName
Get the name of the function, or null if it is anonymous- Returns:
- the function name, or null for an anonymous inline function
-
getDescription
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
-
getArity
public int getArity()Get the arity of the function- Returns:
- the number of arguments in the function signature
-
setAnnotations
-
getAnnotations
Description copied from interface:FunctionItem
Get the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.- Specified by:
getAnnotations
in interfaceFunctionItem
- Overrides:
getAnnotations
in classAbstractFunction
- Returns:
- the function annotations
-
call
Invoke the function- Parameters:
context
- the XPath dynamic evaluation contextargs
- the actual arguments to be supplied- Returns:
- the result of invoking the function
- Throws:
XPathException
- if a dynamic error occurs within the function
-
export
Output information about this function item to the diagnostic explain() output- Specified by:
export
in interfaceFunctionItem
- Overrides:
export
in classAbstractFunction
- Parameters:
out
- the destination for the output
-