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
public class SpecificFunctionType extends AnyFunctionType
An instance of this class represents a specific function item type, for example function(xs:int) as xs:boolean
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType
ItemType.WithSequenceTypeCache
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.type.AnyFunctionType
ANY_FUNCTION
-
-
Constructor Summary
Constructors Constructor Description SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType)SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType, AnnotationList annotations)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object other)Test whether this function type equals another function typejava.util.Optional<java.lang.String>explainMismatch(Item item, TypeHierarchy th)Get extra diagnostic information about why a supplied item does not conform to this item type, if available.AnnotationListgetAnnotationAssertions()Get the list of annotation assertions defined on this function item type.SequenceType[]getArgumentTypes()Get the argument typesintgetArity()Get the arity (number of arguments) of this function typedoublegetDefaultPriority()Get the default priority when this ItemType is used as an XSLT patternSequenceTypegetResultType()Get the result typeinthashCode()Returns a hash code value for the object.booleanisAtomizable(TypeHierarchy th)Ask whether values of this type are atomizableExpressionmakeFunctionSequenceCoercer(Expression exp, RoleDiagnostic role)Create an expression whose effect is to apply function coercion to coerce a function from this type to another typebooleanmatches(Item item, TypeHierarchy th)Test whether a given item conforms to this typeAffinityrelationship(FunctionItemType other, TypeHierarchy th)Determine the relationship of one function item type to another.java.lang.StringtoExportString()Return a string representation of this ItemType suitable for use in stylesheet export files.java.lang.StringtoString()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, isTrueItemType
-
-
-
-
Constructor Detail
-
SpecificFunctionType
public SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType)
-
SpecificFunctionType
public SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType, AnnotationList annotations)
-
-
Method Detail
-
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
public SequenceType[] getArgumentTypes()
Get the argument types- Specified by:
getArgumentTypesin interfaceFunctionItemType- Overrides:
getArgumentTypesin classAnyFunctionType- Returns:
- the list of argument types
-
getResultType
public SequenceType getResultType()
Get the result type- Specified by:
getResultTypein interfaceFunctionItemType- Overrides:
getResultTypein classAnyFunctionType- Returns:
- the result type
-
getAnnotationAssertions
public AnnotationList getAnnotationAssertions()
Get the list of annotation assertions defined on this function item type.- Specified by:
getAnnotationAssertionsin interfaceFunctionItemType- Overrides:
getAnnotationAssertionsin classAnyFunctionType- Returns:
- the list of annotation assertions, or an empty list if there are none
-
isAtomizable
public boolean isAtomizable(TypeHierarchy th)
Ask whether values of this type are atomizable- Specified by:
isAtomizablein interfaceItemType- Overrides:
isAtomizablein 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
public java.lang.String toString()
Produce a representation of this type name for use in error messages.- Specified by:
toStringin interfaceItemType- Overrides:
toStringin classAnyFunctionType- Returns:
- a string representation of the type, in notation resembling but not necessarily identical to XPath syntax
-
toExportString
public java.lang.String toExportString()
Description copied from interface:ItemTypeReturn 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
public boolean equals(java.lang.Object other)
Test whether this function type equals another function type- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
Returns a hash code value for the object.- Overrides:
hashCodein classjava.lang.Object
-
relationship
public Affinity relationship(FunctionItemType other, TypeHierarchy th)
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:
relationshipin interfaceFunctionItemType- Overrides:
relationshipin classAnyFunctionType- 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:
getDefaultPriorityin interfaceItemType- Overrides:
getDefaultPriorityin classAnyFunctionType- Returns:
- the default priority
-
matches
public boolean matches(Item item, TypeHierarchy th)
Test whether a given item conforms to this type- Specified by:
matchesin interfaceItemType- Overrides:
matchesin 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
public java.util.Optional<java.lang.String> explainMismatch(Item item, TypeHierarchy th)
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, RoleDiagnostic role) throws XPathException
Description copied from class:AnyFunctionTypeCreate an expression whose effect is to apply function coercion to coerce a function from this type to another type- Specified by:
makeFunctionSequenceCoercerin interfaceFunctionItemType- Overrides:
makeFunctionSequenceCoercerin classAnyFunctionType- Parameters:
exp- the expression that delivers the supplied sequence of function items (the ones in need of coercion)role- information for use in diagnostics- Returns:
- the sequence of coerced functions, each on a function that calls the corresponding original function after checking the parameters
- Throws:
XPathException
-
-