public static class BuiltInFunctionSet.Entry
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
int |
applicability
Flags indicating which host languages the function is applicable to
|
SequenceType[] |
argumentTypes
An array holding the types of the arguments to the function
|
int |
arity
The arity of the function
|
int |
cardinality
The cardinality of the result of the function
|
java.lang.Class |
implementationClass
The class containing the implementation of this function (always a subclass of SystemFunction)
|
ItemType |
itemType
The item type of the result of the function
|
StructuredQName |
name
The name of the function as a QName
|
OptionsParameter |
optionDetails
For options parameters, details of the accepted options, their defaults, and required type
|
int |
properties
Any additional properties.
|
Sequence[] |
resultIfEmpty
An array holding, for each declared argument, the value that is to be returned if an empty sequence
as the value of this argument allows the result to be determined irrespective of the values of the
other arguments; null if there is no such calculation possible
|
java.lang.Class |
streamingAdjunct
Class used to provide a streaming implementation of the function
|
OperandUsage[] |
usage
The syntactic context of each argument for the purposes of streamability analysis
|
Constructor and Description |
---|
Entry() |
Modifier and Type | Method and Description |
---|---|
BuiltInFunctionSet.Entry |
arg(int a,
ItemType type,
int options,
Sequence resultIfEmpty)
Add information to a function entry about the argument types of the function
|
BuiltInFunctionSet.Entry |
optionDetails(OptionsParameter details)
Add details for options parameters (only applies to one argument, the function is expected to know which)
|
void |
setStreamingAdjunctClass(java.lang.Class streamer)
Define the class to be used to provide a streaming implementation of the function
|
public StructuredQName name
public java.lang.Class implementationClass
public int arity
public ItemType itemType
public int cardinality
public int applicability
public OperandUsage[] usage
public SequenceType[] argumentTypes
public Sequence[] resultIfEmpty
public int properties
public OptionsParameter optionDetails
public java.lang.Class streamingAdjunct
public BuiltInFunctionSet.Entry arg(int a, ItemType type, int options, Sequence resultIfEmpty)
a
- the position of the argument, counting from zerotype
- the item type of the argumentoptions
- the cardinality and usage of the argumentresultIfEmpty
- the value returned by the function if an empty sequence appears as the value
of this argument, in the case when this result is unaffected by any other arguments. Supply null
if this does not apply.public BuiltInFunctionSet.Entry optionDetails(OptionsParameter details)
public void setStreamingAdjunctClass(java.lang.Class streamer)
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.