|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XMLClassDescriptorResolver
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.
Method Summary | |
---|---|
void |
addClass(java.lang.Class clazz)
Loads the class descriptor for the class instance specified. |
void |
addClass(java.lang.String className)
Loads the class descriptor for the class instance specified. |
void |
addClasses(java.lang.Class[] clazzes)
Loads the class descriptors for the class instances specified. |
void |
addClasses(java.lang.String[] classNames)
Loads the class descriptors for the class instances specified. |
void |
addPackage(java.lang.String packageName)
Loads class descriptors from the package specified. |
void |
addPackages(java.lang.String[] packageNames)
Loads class descriptors from the packages specified. |
void |
cleanDescriptorCache()
To clear the descriptor cache. |
void |
loadClassDescriptors(java.lang.String packageName)
Deprecated. Please use e.g. #addPackage(String) instead. |
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. |
java.util.Iterator |
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 |
setClassLoader(java.lang.ClassLoader loader)
Sets the ClassLoader to use when loading class descriptors. |
void |
setInternalContext(InternalContext xmlContext)
To set the XMLContext to be used. |
void |
setIntrospector(Introspector introspector)
To set the Introspector to be used. |
void |
setLoadPackageMappings(boolean loadPackageMappings)
Sets whether or not to look for and load package specific mapping files (".castor.xml"). |
void |
setResolverStrategy(ResolverStrategy resolverStrategy)
The resolver strategy to use for class and package resolving. |
void |
setUseIntrospection(boolean enable)
Enables or disables introspection. |
Methods inherited from interface org.exolab.castor.xml.ClassDescriptorResolver |
---|
getMappingLoader, resolve, setMappingLoader |
Method Detail |
---|
void setInternalContext(InternalContext xmlContext)
xmlContext
- the XMLContext to be usedvoid setUseIntrospection(boolean enable)
enable
- a flag to indicate whether or not introspection is allowed.void setLoadPackageMappings(boolean loadPackageMappings)
loadPackageMappings
- a boolean that enables or disables the loading of package
specific mapping filesvoid setClassLoader(java.lang.ClassLoader loader)
loader
- the ClassLoader to usevoid setResolverStrategy(ResolverStrategy resolverStrategy)
resolverStrategy
- the ResolverStrategy to use for resolve callsvoid setIntrospector(Introspector introspector)
introspector
- the Introspector to useXMLClassDescriptor resolve(java.lang.String className) throws ResolverException
className
- the class name to find the XMLClassDescriptor for
ResolverException
- in case that resolving fails unrecoverableXMLClassDescriptor resolve(java.lang.String className, java.lang.ClassLoader loader) throws ResolverException
className
- the class name to find the XMLClassDescriptor forloader
- the ClassLoader to use
ResolverException
- in case that resolving fails unrecoverableXMLClassDescriptor resolveByXMLName(java.lang.String xmlName, java.lang.String namespaceURI, java.lang.ClassLoader loader) throws ResolverException
xmlName
- The class name to find the XMLClassDescriptor for.namespaceURI
- The namespace URI to identify the XMLClassDescriptor.loader
- The ClassLoader to use.
ResolverException
- in case that resolving fails unrecoverablejava.util.Iterator resolveAllByXMLName(java.lang.String xmlName, java.lang.String namespaceURI, java.lang.ClassLoader loader) throws ResolverException
xmlName
- The class name to find the XMLClassDescriptor for.namespaceURI
- The namespace URI to identify the XMLClassDescriptor.loader
- The ClassLoader to use.
ResolverException
- in case that resolving fails unrecoverablevoid addClass(java.lang.String className) throws ResolverException
className
- Name of the class for which the associated descriptor should
be loaded.
ResolverException
- If there's an unrecoverable problem with resolving a certain
class.void addClasses(java.lang.String[] classNames) throws ResolverException
classNames
- Names of the classes for which the associated descriptors
should be loaded.
ResolverException
- If there's an unrecoverable problem with resolving a certain
class.void addClass(java.lang.Class clazz) throws ResolverException
clazz
- Class for which the associated descriptor should be loaded.
ResolverException
- If there's an unrecoverable problem with resolving a certain
class.void addClasses(java.lang.Class[] clazzes) throws ResolverException
clazzes
- Classes for which the associated descriptors should be loaded.
ResolverException
- If there's an unrecoverable problem with resolving a certain
class.void addPackage(java.lang.String packageName) throws ResolverException
Please note that this functionality will work only if you provide the .castor.cdr file with your generated classes (as generated by the XML code generator).
packageName
- The package name for the (descriptor) classes
ResolverException
- If there's a problem loading class descriptors for the given
package.void addPackages(java.lang.String[] packageNames) throws ResolverException
Please note that this functionality will work only if you provide the .castor.cdr files with your generated classes (as generated by the XML code generator).
packageNames
- The package names for the (descriptor) classes
ResolverException
- If there's a problem loading class descriptors for the given
package.void loadClassDescriptors(java.lang.String packageName) throws ResolverException
Please note that this functionality will work only if you provide the .castor.cdr file with your generated classes (as generated by the XML code generator).
packageName
- The package name for the (descriptor) classes
ResolverException
- If there's a problem loading class descriptors for the given
package.void cleanDescriptorCache()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |