Package net.sf.saxon.type

## Class AnyExternalObjectType

- java.lang.Object
- - net.sf.saxon.type.AnyExternalObjectType

- All Implemented Interfaces:
    `ItemType`
  Direct Known Subclasses:
    `ExternalObjectType`

      public class AnyExternalObjectType
      extends java.lang.Object
      implements ItemType

  This class represents the type of an external object returned by an extension function, or supplied as an external variable/parameter.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType

      `ItemType.WithSequenceTypeCache`

  - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static AnyExternalObjectType` | `THE_INSTANCE` |

  - ### Constructor Summary

    Constructors
    Modifier | Constructor | Description
    --- | --- | ---
    `protected` | `AnyExternalObjectType()` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `AtomicType` | `getAtomizedItemType()` | Get the item type of the atomic values that will be produced when an item of this type is atomized
    `java.lang.String` | `getBasicAlphaCode()` | Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.
    `double` | `getDefaultPriority()` | Get the default priority when this ItemType is used as an XSLT pattern
    `Genre` | `getGenre()` | Determine the Genre (top-level classification) of this type
    `ItemType` | `getPrimitiveItemType()` | Get the primitive item type corresponding to this item type.
    `int` | `getPrimitiveType()` | Get the primitive type corresponding to this item type.
    `UType` | `getUType()` | Get the corresponding `UType`.
    `boolean` | `isAtomicType()` | Determine whether this item type is an atomic type
    `boolean` | `isAtomizable​(TypeHierarchy th)` | Ask whether values of this type are atomizable
    `boolean` | `isPlainType()` | Determine whether this item type is a plain type (that is, whether it can ONLY match atomic values)
    `boolean` | `matches​(Item item, TypeHierarchy th)` | Test whether a given item conforms to this type

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface net.sf.saxon.type.ItemType

      `explainMismatch, getFullAlphaCode, getNormalizedDefaultPriority, isTrueItemType, toExportString, toString`

- - ### Field Detail

    - #### THE_INSTANCE

          public static AnyExternalObjectType THE_INSTANCE

  - ### Constructor Detail

    - #### AnyExternalObjectType

          protected AnyExternalObjectType()

  - ### Method Detail

    - #### isAtomicType

          public boolean isAtomicType()

      Description copied from interface: `ItemType`
      Determine whether this item type is an atomic type
      Specified by:
        `isAtomicType` in interface `ItemType`
      Returns:
        true if this is ANY_ATOMIC_TYPE or a subtype thereof

    - #### matches

          public boolean matches​(Item item,
                                 TypeHierarchy th)
                          throws XPathException

      Description copied from interface: `ItemType`
      Test whether a given item conforms to this type
      Specified by:
        `matches` in interface `ItemType`
      Parameters:
        `item` - The item to be tested
        `th` - The type hierarchy cache. Currently used only when matching function items.
      Returns:
        true if the item is an instance of this type; false otherwise
      Throws:
        `XPathException`

    - #### isPlainType

          public boolean isPlainType()

      Description copied from interface: `ItemType`
      Determine whether this item type is a plain type (that is, whether it can ONLY match atomic values)
      Specified by:
        `isPlainType` in interface `ItemType`
      Returns:
        true if this is ANY_ATOMIC_TYPE or a subtype thereof, or a "plain" union type (that is, unions of atomic types that impose no further restrictions). Return false if this is a union type whose member types are not all known.

    - #### getPrimitiveType

          public int getPrimitiveType()

      Description copied from interface: `ItemType`
      Get the primitive type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is BuiltInAtomicType.ANY_ATOMIC. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that INTEGER is considered to be a primitive type.
      Specified by:
        `getPrimitiveType` in interface `ItemType`
      Returns:
        the integer fingerprint of the corresponding primitive type

    - #### getBasicAlphaCode

          public java.lang.String getBasicAlphaCode()

      Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived. The codes are designed so that for any two built-in types A and B, alphaCode(A) is a prefix of alphaCode(B) if and only if A is a supertype of B.
      Specified by:
        `getBasicAlphaCode` in interface `ItemType`
      Returns:
        the alphacode for the nearest containing built-in type

    - #### getPrimitiveItemType

          public ItemType getPrimitiveItemType()

      Description copied from interface: `ItemType`
      Get the primitive item type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue and union types it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that integer, xs:dayTimeDuration, and xs:yearMonthDuration are considered to be primitive types.
      Specified by:
        `getPrimitiveItemType` in interface `ItemType`
      Returns:
        the corresponding primitive type

    - #### getUType

          public UType getUType()

      Description copied from interface: `ItemType`
      Get the corresponding `UType`. A UType is a union of primitive item types.
      Specified by:
        `getUType` in interface `ItemType`
      Returns:
        the smallest UType that subsumes this item type

    - #### getAtomizedItemType

          public AtomicType getAtomizedItemType()

      Description copied from interface: `ItemType`
      Get the item type of the atomic values that will be produced when an item of this type is atomized
      Specified by:
        `getAtomizedItemType` in interface `ItemType`
      Returns:
        the best available item type of the atomic values that will be produced when an item of this type is atomized, or null if it is known that atomization will throw an error.

    - #### isAtomizable

          public boolean isAtomizable​(TypeHierarchy th)

      Description copied from interface: `ItemType`
      Ask whether values of this type are atomizable
      Specified by:
        `isAtomizable` in interface `ItemType`
      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

    - #### getGenre

          public Genre getGenre()

      Description copied from interface: `ItemType`
      Determine the Genre (top-level classification) of this type
      Specified by:
        `getGenre` in interface `ItemType`
      Returns:
        the Genre to which this type belongs, for example node or atomic value

    - #### getDefaultPriority

          public double getDefaultPriority()

      Get the default priority when this ItemType is used as an XSLT pattern
      Specified by:
        `getDefaultPriority` in interface `ItemType`
      Returns:
        the default priority