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

  • Field Details

  • Constructor Details

    • SpecificFunctionType

      public SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType)
      Construct a specific function type
      Parameters:
      argTypes - the types of the arguments to the function
      resultType - the type of the function result

    • SpecificFunctionType

      public SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType, AnnotationList annotations)
      Construct a specific function type including function annotations
      Parameters:
      argTypes - the types of the arguments to the function
      resultType - the type of the function result
      annotations - the function annotations

    • SpecificFunctionType

      public SpecificFunctionType(SequenceType... types)
      Convenience variadic constructor
      Parameters:
      types - the argument types, followed by the result type

  • 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

    • withAcceptReducedArity

      public SpecificFunctionType withAcceptReducedArity()
      Indicate that this function type describes a callback function, and that the caller of this callback is prepared to accept a reduced-arity version of the function directly, without needing it to be wrapped in a CoercedFunction that accepts and swallows the superfluous arguments. This is useful where it means that the caller does not need to compute additional argument values just for them to be ignored.
      Returns:
      this, after setting the acceptReducedArity flag.

    • isAcceptReducedArity

      public boolean isAcceptReducedArity()

    • acceptsReducedArityFunction

      public boolean acceptsReducedArityFunction(ItemType supplied)
      Ask whether a function of a supplied type is acceptable, despite not being an exact match, without needing to be wrapped in a CoercedFunction
      Parameters:
      supplied - the item type of a supplied function
      Returns:
      true if the caller is able to call the supplied function without further wrapping

    • getArgumentTypes

      public SequenceType[] getArgumentTypes()
      Get the argument types
      Specified by:
      getArgumentTypes in interface FunctionItemType
      Overrides:
      getArgumentTypes in class AnyFunctionType
      Returns:
      the list of argument types

    • getResultType

      public SequenceType getResultType()
      Get the result type
      Specified by:
      getResultType in interface FunctionItemType
      Overrides:
      getResultType in class AnyFunctionType
      Returns:
      the result type

    • getAnnotationAssertions

      public AnnotationList getAnnotationAssertions()
      Get the list of annotation assertions defined on this function item type.
      Specified by:
      getAnnotationAssertions in interface FunctionItemType
      Overrides:
      getAnnotationAssertions in class AnyFunctionType
      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:
      isAtomizable in interface ItemType
      Overrides:
      isAtomizable in class AnyFunctionType
      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 String toString()
      Produce a representation of this type name for use in error messages.
      Overrides:
      toString in class AnyFunctionType
      Returns:
      a string representation of the type, in notation resembling but not necessarily identical to XPath syntax

    • toExportString

      public String 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 calling toString().
      Returns:
      the string representation as an instance of the XPath SequenceType construct

    • equals

      public boolean equals(Object other)
      Test whether this function type equals another function type
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Returns a hash code value for the object.
      Overrides:
      hashCode in class Object

    • relationship

      public Affinity relationship(FunctionItemType other)
      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 interface FunctionItemType
      Overrides:
      relationship in class AnyFunctionType
      Parameters:
      other - the other function item type
      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 interface ItemType
      Overrides:
      getDefaultPriority in class AnyFunctionType
      Returns:
      the default priority

    • matches

      public boolean matches(Item item)
      Test whether a given item conforms to this type
      Specified by:
      matches in interface ItemType
      Overrides:
      matches in class AnyFunctionType
      Parameters:
      item - The item to be tested
      Returns:
      true if the item is an instance of this type; false otherwise

    • explainMismatch

      public Optional<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.
      Specified by:
      explainMismatch in interface ItemType
      Overrides:
      explainMismatch in class AnyFunctionType
      Parameters:
      item - the item that doesn't match this type
      th - 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 interface FunctionItemType
      Overrides:
      makeFunctionSequenceCoercer in class AnyFunctionType
      Parameters:
      exp - the expression that delivers the supplied sequence of function items (the ones in need of coercion)
      role - information for use in diagnostics
      allow40 -
      Returns:
      the sequence of coerced functions, each on a function that calls the corresponding original function after checking the parameters

    • getCoercionPlan

      public CoercionPlan getCoercionPlan(int version)
      Get the coercion plan for use when this type is the required type for (say) coercion of arguments in a function call
      Specified by:
      getCoercionPlan in interface ItemType
      Overrides:
      getCoercionPlan in class AnyFunctionType
      Parameters:
      version - the XPath language version (40 or 31)