Class 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
    • 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
      • 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 java.lang.String toString()
        Produce a representation of this type name for use in error messages.
        Specified by:
        toString in interface ItemType
        Overrides:
        toString in class AnyFunctionType
        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: 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​(java.lang.Object other)
        Test whether this function type equals another function type
        Overrides:
        equals in class java.lang.Object
      • hashCode

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

        public boolean matches​(Item item,
                               TypeHierarchy th)
        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
        th - 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 type
        th - the type hierarchy cache
        Returns:
        optionally, a message explaining why the item does not match the type