Package net.sf.saxon.type
Class SpecificFunctionType
java.lang.Object
net.sf.saxon.type.AnyFunctionType
net.sf.saxon.type.SpecificFunctionType
- All Implemented Interfaces:
FunctionItemType
,ItemType
An instance of this class represents a specific function item type, for example
function(xs:int) as xs:boolean
-
Field Summary
FieldsFields inherited from class net.sf.saxon.type.AnyFunctionType
ANY_FUNCTION
-
Constructor Summary
ConstructorsConstructorDescriptionSpecificFunctionType
(SequenceType[] argTypes, SequenceType resultType) SpecificFunctionType
(SequenceType[] argTypes, SequenceType resultType, AnnotationList annotations) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Test whether this function type equals another function typeexplainMismatch
(Item item, TypeHierarchy th) Get extra diagnostic information about why a supplied item does not conform to this item type, if available.Get the list of annotation assertions defined on this function item type.Get the argument typesint
getArity()
Get the arity (number of arguments) of this function typedouble
Get the default priority when this ItemType is used as an XSLT patternGet the result typeint
hashCode()
Returns a hash code value for the object.boolean
Ask whether values of this type are atomizablemakeFunctionSequenceCoercer
(Expression exp, Supplier<RoleDiagnostic> role, boolean allow40) Create an expression whose effect is to apply function coercion to coerce a function from this type to another typeboolean
matches
(Item item, TypeHierarchy th) Test whether a given item conforms to this typerelationship
(FunctionItemType other, TypeHierarchy th) Determine the relationship of one function item type to another.Return a string representation of this ItemType suitable for use in stylesheet export files.toString()
Produce a representation of this type name for use in error messages.Methods inherited from class net.sf.saxon.type.AnyFunctionType
getAtomizedItemType, getBasicAlphaCode, getInstance, getPrimitiveItemType, getPrimitiveType, getUType, isArrayType, isAtomicType, isMapType, isPlainType
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.type.FunctionItemType
getGenre
Methods inherited from interface net.sf.saxon.type.ItemType
getFullAlphaCode, getNormalizedDefaultPriority
-
Field Details
-
COMPONENT_FUNCTION_TYPE
-
-
Constructor Details
-
SpecificFunctionType
-
SpecificFunctionType
public SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType, AnnotationList annotations)
-
-
Method Details
-
getArity
public int getArity()Get the arity (number of arguments) of this function type- Returns:
- the number of argument types in the function signature
-
getArgumentTypes
Get the argument types- Specified by:
getArgumentTypes
in interfaceFunctionItemType
- Overrides:
getArgumentTypes
in classAnyFunctionType
- Returns:
- the list of argument types
-
getResultType
Get the result type- Specified by:
getResultType
in interfaceFunctionItemType
- Overrides:
getResultType
in classAnyFunctionType
- Returns:
- the result type
-
getAnnotationAssertions
Get the list of annotation assertions defined on this function item type.- Specified by:
getAnnotationAssertions
in interfaceFunctionItemType
- Overrides:
getAnnotationAssertions
in classAnyFunctionType
- Returns:
- the list of annotation assertions, or an empty list if there are none
-
isAtomizable
Ask whether values of this type are atomizable- Specified by:
isAtomizable
in interfaceItemType
- Overrides:
isAtomizable
in classAnyFunctionType
- Parameters:
th
- The type hierarchy cache- Returns:
- true if some or all instances of this type can be successfully atomized; false * if no instances of this type can be atomized
-
toString
Produce a representation of this type name for use in error messages.- Overrides:
toString
in classAnyFunctionType
- Returns:
- a string representation of the type, in notation resembling but not necessarily identical to XPath syntax
-
toExportString
Description copied from interface:ItemType
Return a string representation of this ItemType suitable for use in stylesheet export files. This differs from the result of toString() in that it will not contain any references to anonymous types. Note that it may also use the Saxon extended syntax for union types and tuple types. The default implementation returns the result of callingtoString()
.- Returns:
- the string representation as an instance of the XPath SequenceType construct
-
equals
Test whether this function type equals another function type -
hashCode
public int hashCode()Returns a hash code value for the object. -
relationship
Determine the relationship of one function item type to another. This method is only concerned with the type signatures of the two function item types, and not with their annotation assertions.- Specified by:
relationship
in interfaceFunctionItemType
- Overrides:
relationship
in classAnyFunctionType
- Parameters:
other
- the other function item typeth
- the type hierarchy cache- Returns:
- for example
Affinity.SUBSUMES
,Affinity.SAME_TYPE
-
getDefaultPriority
public double getDefaultPriority()Get the default priority when this ItemType is used as an XSLT pattern- Specified by:
getDefaultPriority
in interfaceItemType
- Overrides:
getDefaultPriority
in classAnyFunctionType
- Returns:
- the default priority
-
matches
Test whether a given item conforms to this type- Specified by:
matches
in interfaceItemType
- Overrides:
matches
in classAnyFunctionType
- Parameters:
item
- The item to be testedth
- the type hierarchy cache- Returns:
- true if the item is an instance of this type; false otherwise
-
explainMismatch
Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.- Parameters:
item
- the item that doesn't match this typeth
- the type hierarchy cache- Returns:
- optionally, a message explaining why the item does not match the type
-
makeFunctionSequenceCoercer
public Expression makeFunctionSequenceCoercer(Expression exp, Supplier<RoleDiagnostic> role, boolean allow40) Description copied from class:AnyFunctionType
Create an expression whose effect is to apply function coercion to coerce a function from this type to another type- Specified by:
makeFunctionSequenceCoercer
in interfaceFunctionItemType
- Overrides:
makeFunctionSequenceCoercer
in classAnyFunctionType
- Parameters:
exp
- the expression that delivers the supplied sequence of function items (the ones in need of coercion)role
- information for use in diagnosticsallow40
-- Returns:
- the sequence of coerced functions, each on a function that calls the corresponding original function after checking the parameters
-