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 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
 java.lang.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(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

getErrorMessage

public java.lang.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

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

getMappingLoader

public XMLMappingLoader getMappingLoader()

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


resolve

public XMLClassDescriptor resolve(java.lang.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(java.lang.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(java.lang.String className,
                                  java.lang.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

resolveByXMLName

public 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. Null is returned if no descriptor can be found.

Parameters:
loader - the ClassLoader to use
Returns:
the XMLClassDescriptor for the given XML name

resolveAllByXMLName

public 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

Parameters:
loader - the ClassLoader to use
Returns:
an enumeration of XMLClassDescriptor objects.

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-2004. All rights reserved http://www.intalio.com