JavaExternalObjectType

java.lang.Object
- net.sf.saxon.type.ExternalObjectType
- - net.sf.saxon.type.JavaExternalObjectType

All Implemented Interfaces:

ItemType
```
public class JavaExternalObjectType
extends ExternalObjectType
implements ItemType
```
This class represents the type of an external Java 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 and Description

static JavaExternalObjectType EXTERNAL_OBJECT_TYPE

Fields
Modifier and Type	Field and Description
`static JavaExternalObjectType`	`EXTERNAL_OBJECT_TYPE`

Constructor Summary

Constructors
Constructor and Description
`JavaExternalObjectType(java.lang.Class javaClass)` Create an external object type.
`JavaExternalObjectType(java.lang.Class javaClass, Configuration config)` Create an external object type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`classNameToLocalName(java.lang.String className)` Static method to convert a Java class name to an XPath local name.
`static StructuredQName`	`classNameToQName(java.lang.String className)` Static method to get the QName corresponding to a Java class name
`boolean`	`equals(java.lang.Object obj)` Test whether two ExternalObjectType objects represent the same type
`AtomicType`	`getAtomizedItemType()` Get the item type of the atomic values that will be produced when an item of this type is atomized
`double`	`getDefaultPriority()` Determine the default priority of this item type when used on its own as a Pattern
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDisplayName()`
`java.lang.Class`	`getJavaClass()` Get the Java class to which this external object type corresponds
`java.lang.String`	`getName()` Get the local name 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.
`int`	`getRelationship(JavaExternalObjectType other)` Get the relationship of this external object type to another external object type
`java.lang.String`	`getTargetNamespace()` Get the target namespace of this type.
`StructuredQName`	`getTypeName()` Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null
`UType`	`getUType()` Get the corresponding `UType`.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isAtomicType()` Test whether this item type is an atomic type
`boolean`	`isAtomizable()` Ask whether values of this type are atomizable
`boolean`	`isExternalType()` Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
`static java.lang.String`	`localNameToClassName(java.lang.String className)` Static method to convert an XPath local name to a Java class name.
`boolean`	`matches(Item item, TypeHierarchy th)` Test whether a given item conforms to this type
`java.lang.String`	`toExportString()` Return a string representation of this SequenceType suitable for use in export (SEF) files.
`java.lang.String`	`toString()`
`void`	`visitNamedSchemaComponents(SchemaComponentVisitor visitor)` Visit all the schema components used in this ItemType definition

Methods inherited from class net.sf.saxon.type.ExternalObjectType
generateJavaScriptItemTypeAcceptor, generateJavaScriptItemTypeTest, isPlainType

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.type.ItemType
generateJavaScriptItemTypeAcceptor, generateJavaScriptItemTypeTest, isPlainType

- Field Detail
  - EXTERNAL_OBJECT_TYPE
```
public static JavaExternalObjectType EXTERNAL_OBJECT_TYPE
```
- Constructor Detail
  - JavaExternalObjectType
```
public JavaExternalObjectType(java.lang.Class javaClass)
```
    Create an external object type.
    
    Parameters:
    
    javaClass - the Java class to which this type corresponds
  - JavaExternalObjectType
```
public JavaExternalObjectType(java.lang.Class javaClass,
                              Configuration config)
```
    Create an external object type.
    
    Parameters:
    
    javaClass - the Java class to which this type corresponds
    
    config - the Saxon configuration. This argument is no longer used (since 9.5).
- Method Detail
  - getUType
```
public UType getUType()
```
    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
  - getName
```
public java.lang.String getName()
```
    Get the local name of this type.
    
    Specified by:
    
    getName in class ExternalObjectType
    
    Returns:
    
    the fully qualified name of the Java class.
  - getTargetNamespace
```
public java.lang.String getTargetNamespace()
```
    Get the target namespace of this type. The is always NamespaceConstant.JAVA_TYPE.
    
    Specified by:
    
    getTargetNamespace in class ExternalObjectType
    
    Returns:
    
    the target namespace of this type definition.
  - isExternalType
```
public boolean isExternalType()
```
    Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
    
    Overrides:
    
    isExternalType in class ExternalObjectType
    
    Returns:
    
    true (always)
  - getTypeName
```
public StructuredQName getTypeName()
```
    Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null
    
    Specified by:
    
    getTypeName in class ExternalObjectType
    
    Returns:
    
    the name of the atomic type, or null if the type is anonymous.
  - getPrimitiveItemType
```
public ItemType getPrimitiveItemType()
```
    Get the primitive item type corresponding to this item type.
    
    Specified by:
    
    getPrimitiveItemType in interface ItemType
    
    Returns:
    
    EXTERNAL_OBJECT_TYPE, the ExternalObjectType that encapsulates the Java type Object.class.
  - getPrimitiveType
```
public int getPrimitiveType()
```
    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 Type.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
    
    Specified by:
    
    getPrimitiveType in class ExternalObjectType
    
    Returns:
    
    the fingerprint of the primitive type
  - getAtomizedItemType
```
public AtomicType getAtomizedItemType()
```
    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:
    
    BuiltInAtomicType.STRING, because atomization returns the result of toString()
  - isAtomizable
```
public boolean isAtomizable()
```
    Ask whether values of this type are atomizable
    
    Specified by:
    
    isAtomizable in interface ItemType
    
    Returns:
    
    true, because (since Saxon 9.5) atomization will always return the result of toString()
  - getRelationship
```
public int getRelationship(JavaExternalObjectType other)
```
    Get the relationship of this external object type to another external object type
    
    Parameters:
    
    other - the other external object type
    
    Returns:
    
    the relationship of this external object type to another external object type, as one of the constants in class TypeHierarchy, for example TypeHierarchy.SUBSUMES
  - getDescription
```
public java.lang.String getDescription()
```
  - isAtomicType
```
public boolean isAtomicType()
```
    Test whether this item type is an atomic type
    
    Specified by:
    
    isAtomicType in interface ItemType
    
    Returns:
    
    false, this is not considered to be an atomic type
  - getJavaClass
```
public java.lang.Class getJavaClass()
```
    Get the Java class to which this external object type corresponds
    
    Returns:
    
    the corresponding Java class
  - matches
```
public boolean matches(Item item,
                       TypeHierarchy th)
```
    Test whether a given item conforms to this type
    
    Specified by:
    
    matches in interface ItemType
    
    Parameters:
    
    item - The item to be tested
    
    th -
    
    Returns:
    
    true if the item is an instance of this type; false otherwise
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface ItemType
    
    Overrides:
    
    toString in class java.lang.Object
  - toExportString
```
public java.lang.String toExportString()
```
    Return a string representation of this SequenceType suitable for use in export (SEF) files. The difference from the toString() method is that the representation will not contain references to anonymous types.
    
    Specified by:
    
    toExportString in interface ItemType
    
    Returns:
    
    the string representation as an instance of the XPath SequenceType construct, using only names that will be in-scope if the target environment imports the same schema as the source environment
  - getDisplayName
```
public java.lang.String getDisplayName()
```
  - getDefaultPriority
```
public double getDefaultPriority()
```
    Determine the default priority of this item type when used on its own as a Pattern
    
    Returns:
    
    the default priority
  - visitNamedSchemaComponents
```
public void visitNamedSchemaComponents(SchemaComponentVisitor visitor)
                                throws XPathException
```
    Visit all the schema components used in this ItemType definition
    
    Specified by:
    
    visitNamedSchemaComponents in interface ItemType
    
    Parameters:
    
    visitor - the visitor class to be called when each component is visited
    
    Throws:
    
    XPathException - if an error occurs
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Test whether two ExternalObjectType objects represent the same type
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the other ExternalObjectType
    
    Returns:
    
    true if the two objects represent the same type
  - classNameToLocalName
```
public static java.lang.String classNameToLocalName(java.lang.String className)
```
    Static method to convert a Java class name to an XPath local name. This involves the following substitutions: "$" is replaced by "-", and "[" is replaced by "_-".
  - localNameToClassName
```
public static java.lang.String localNameToClassName(java.lang.String className)
```
    Static method to convert an XPath local name to a Java class name. This involves the following substitutions: "-" is replaced by "$", and leading "_-" pairs are replaced by "[".
  - classNameToQName
```
public static StructuredQName classNameToQName(java.lang.String className)
```
    Static method to get the QName corresponding to a Java class name

Class JavaExternalObjectType

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.sf.saxon.type.ExternalObjectType

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNAL_OBJECT_TYPE

Constructor Detail

JavaExternalObjectType

JavaExternalObjectType

Method Detail

getUType

getName

getTargetNamespace

isExternalType

getTypeName

getPrimitiveItemType

getPrimitiveType

getAtomizedItemType

isAtomizable

getRelationship

getDescription

isAtomicType

getJavaClass

matches

toString

toExportString

getDisplayName

getDefaultPriority

visitNamedSchemaComponents

hashCode

equals

classNameToLocalName

localNameToClassName

classNameToQName