org.exolab.castor.xml
Interface ClassDescriptorResolver

All Known Implementing Classes:

ClassDescriptorResolverImpl

public interface ClassDescriptorResolver

An interface for finding or "resolving" XMLClassDescriptor classes.
Note: This interface is used by the marshalling Framework for resolving XMLClassDescriptors for non-primitive types. There are no guarantees that this class will be called for java native classes.

Version:

$Revision: 1.2 $ $Date: 2005/03/01 00:41:38 $

Author:

Keith Visco

Method Summary

XMLMappingLoader	getMappingLoader() Note: This method will be removed soon (kv).
XMLClassDescriptor	resolve(java.lang.Class type) Returns the XMLClassDescriptor for the given class
XMLClassDescriptor	resolve(java.lang.String className) Returns the XMLClassDescriptor for the given class name
XMLClassDescriptor	resolve(java.lang.String className, java.lang.ClassLoader loader) Returns the XMLClassDescriptor for the given class name
ClassDescriptorEnumeration	resolveAllByXMLName(java.lang.String xmlName, java.lang.String namespaceURI, java.lang.ClassLoader loader) Returns an enumeration of XMLClassDescriptor objects that match the given xml name
XMLClassDescriptor	resolveByXMLName(java.lang.String xmlName, java.lang.String namespaceURI, java.lang.ClassLoader loader) Returns the first XMLClassDescriptor that matches the given XML name and namespaceURI.
void	setMappingLoader(XMLMappingLoader xmlMappingLoader) Sets the mapping loader for this ClassDescriptorResolver Note: This method will be removed soon (kv).

Method Detail

getMappingLoader

XMLMappingLoader getMappingLoader()

Note: This method will be removed soon (kv).

resolve

XMLClassDescriptor resolve(java.lang.Class type)
                           throws ResolverException

Returns the XMLClassDescriptor for the given class

Parameters:

type - the Class to find the XMLClassDescriptor for

Returns:

the XMLClassDescriptor for the given class

Throws:

ResolverException

resolve

XMLClassDescriptor resolve(java.lang.String className)
                           throws ResolverException

Returns the XMLClassDescriptor for the given class name

Parameters:

className - the class name to find the XMLClassDescriptor for

Returns:

the XMLClassDescriptor for the given class name

Throws:

ResolverException

resolve

XMLClassDescriptor resolve(java.lang.String className,
                           java.lang.ClassLoader loader)
                           throws ResolverException

Returns the XMLClassDescriptor for the given class name

Parameters:

className - the class name to find the XMLClassDescriptor for

loader - the ClassLoader to use

Returns:

the XMLClassDescriptor for the given class name

Throws:

ResolverException

resolveByXMLName

XMLClassDescriptor resolveByXMLName(java.lang.String xmlName,
                                    java.lang.String namespaceURI,
                                    java.lang.ClassLoader loader)
                                    throws ResolverException

Returns the first XMLClassDescriptor that matches the given XML name and namespaceURI. Null is returned if no descriptor can be found.

Parameters:

className - the class name to find the XMLClassDescriptor for

loader - the ClassLoader to use

Returns:

the XMLClassDescriptor for the given XML name

Throws:

ResolverException

resolveAllByXMLName

ClassDescriptorEnumeration resolveAllByXMLName(java.lang.String xmlName,
                                               java.lang.String namespaceURI,
                                               java.lang.ClassLoader loader)
                                               throws ResolverException

Returns an enumeration of XMLClassDescriptor objects that match the given xml name

Parameters:

className - the class name to find the XMLClassDescriptor for

loader - the ClassLoader to use

Returns:

an enumeration of XMLClassDescriptor objects.

Throws:

ResolverException

setMappingLoader

void setMappingLoader(XMLMappingLoader xmlMappingLoader)

Sets the mapping loader for this ClassDescriptorResolver
Note: This method will be removed soon (kv).