org.exolab.castor.xml

Interface ClassDescriptorResolver

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 is no guarantees that this class will be called for java native classes.
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:09 $
Author:
Keith Visco

Method Summary

boolean
error()
Returns true if an error was generated on the last call to one of the resolve methods
String
getErrorMessage()
Returns the last error message generated If no error String exists, null will be returned
XMLMappingLoader
getMappingLoader()

Note: This method will be removed soon (kv).
XMLClassDescriptor
resolve(Class type)
Returns the XMLClassDescriptor for the given class
XMLClassDescriptor
resolve(String className)
Returns the XMLClassDescriptor for the given class name
XMLClassDescriptor
resolve(String className, ClassLoader loader)
Returns the XMLClassDescriptor for the given class name
ClassDescriptorEnumeration
resolveAllByXMLName(String xmlName, String namespaceURI, ClassLoader loader)
Returns an enumeration of XMLClassDescriptor objects that match the given xml name
XMLClassDescriptor
resolveByXMLName(String xmlName, String namespaceURI, 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 Details

error

public boolean error()
Returns true if an error was generated on the last call to one of the resolve methods
Returns:
true if an error was generated on the last call to one of the resolve methods

getErrorMessage

public String getErrorMessage()
Returns the last error message generated If no error String exists, null will be returned
Returns:
the last error message generated. If no error String exists, null will be returned

getMappingLoader

public XMLMappingLoader getMappingLoader()

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

resolve

public XMLClassDescriptor resolve(Class type)
Returns the XMLClassDescriptor for the given class
Parameters:
type - the Class to find the XMLClassDescriptor for
Returns:
the XMLClassDescriptor for the given class

resolve

public XMLClassDescriptor resolve(String className)
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

resolve

public XMLClassDescriptor resolve(String className,
                                  ClassLoader loader)
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

resolveAllByXMLName

public ClassDescriptorEnumeration resolveAllByXMLName(String xmlName,
                                                      String namespaceURI,
                                                      ClassLoader loader)
Returns an enumeration of XMLClassDescriptor objects that match the given xml name
Parameters:
loader - the ClassLoader to use
Returns:
an enumeration of XMLClassDescriptor objects.

resolveByXMLName

public XMLClassDescriptor resolveByXMLName(String xmlName,
                                           String namespaceURI,
                                           ClassLoader loader)
Returns the first XMLClassDescriptor that matches the given XML name and namespaceURI. Null is returned if no descriptor can be found.
Parameters:
loader - the ClassLoader to use
Returns:
the XMLClassDescriptor for the given XML name

setMappingLoader

public void setMappingLoader(XMLMappingLoader xmlMappingLoader)
Sets the mapping loader for this ClassDescriptorResolver
Note: This method will be removed soon (kv).

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com