Package org.exolab.castor.xml.util
Class XMLClassDescriptorResolverImpl
java.lang.Object
org.exolab.castor.xml.util.XMLClassDescriptorResolverImpl
- All Implemented Interfaces:
ClassDescriptorResolver
,XMLClassDescriptorResolver
The default implementation of the ClassDescriptorResolver interface.
- Version:
- $Revision: 8691 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
- Author:
- Keith Visco
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Loads the class descriptor for the class instance specified.void
Loads the class descriptor for the class instance specified.void
addClasses
(Class<?>[] clazzes) Loads the class descriptors for the class instances specified.void
addClasses
(String[] classNames) Loads the class descriptors for the class instances specified.void
addPackage
(String packageName) Loads class descriptors from the package specified.void
addPackages
(String[] packageNames) Loads class descriptors from the packages specified.void
Cleans the descriptor cache.Note: This method will be removed soon (kv).void
loadClassDescriptors
(String packageName) Deprecated.Returns the ClassDescriptor for the given class.Returns the XMLClassDescriptor for the given class name.resolve
(String className, ClassLoader loader) Returns the XMLClassDescriptor for the given class name.resolveAllByXMLName
(String xmlName, String namespaceURI, ClassLoader loader) Returns an enumeration of XMLClassDescriptor objects that match the given xml name.resolveByXMLName
(String xmlName, String namespaceURI, ClassLoader loader) Returns the first XMLClassDescriptor that matches the given XML name and namespaceURI.void
setClassLoader
(ClassLoader loader) Sets the ClassLoader to use when loading class descriptors.void
setInternalContext
(InternalContext internalContext) 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
setMappingLoader
(MappingLoader mappingLoader) Sets the mapping loader for this ClassDescriptorResolver.void
setResolverStrategy
(ResolverStrategy resolverStrategy) The resolver strategy to use for class and package resolving.void
setUseIntrospection
(boolean enable) Enables or disables introspection.
-
Constructor Details
-
XMLClassDescriptorResolverImpl
public XMLClassDescriptorResolverImpl()Creates a new ClassDescriptorResolverImpl. It is left empty to avoid cycles at construction. To guarantee backward compatibility the backwardInit method will do all required initialization if it hadn't happened before.
-
-
Method Details
-
setInternalContext
To set the XMLContext to be used. The InternalContext itself is not stored! But all values of interest are read and stored in local attributes.- Specified by:
setInternalContext
in interfaceXMLClassDescriptorResolver
- Parameters:
internalContext
- the XMLContext to be used
-
getMappingLoader
Note: This method will be removed soon (kv).- Specified by:
getMappingLoader
in interfaceClassDescriptorResolver
-
setClassLoader
Sets the ClassLoader to use when loading class descriptors.- Specified by:
setClassLoader
in interfaceXMLClassDescriptorResolver
- Parameters:
loader
- the ClassLoader to use
-
setUseIntrospection
public void setUseIntrospection(boolean enable) Enables or disables introspection. Introspection is enabled by default.- Specified by:
setUseIntrospection
in interfaceXMLClassDescriptorResolver
- Parameters:
enable
- a flag to indicate whether or not introspection is allowed.
-
setLoadPackageMappings
public void setLoadPackageMappings(boolean loadPackageMappings) Sets whether or not to look for and load package specific mapping files (".castor.xml").- Specified by:
setLoadPackageMappings
in interfaceXMLClassDescriptorResolver
- Parameters:
loadPackageMappings
- a boolean that enables or disables the loading of package specific mapping files
-
setMappingLoader
Sets the mapping loader for this ClassDescriptorResolver. Note: This method will be removed soon (kv).- Specified by:
setMappingLoader
in interfaceClassDescriptorResolver
-
setIntrospector
To set the Introspector to be used. It is stored as attribute of resolver and set as property into the current strategy.- Specified by:
setIntrospector
in interfaceXMLClassDescriptorResolver
- Parameters:
introspector
- the Introspector to use
-
setResolverStrategy
The resolver strategy to use for class and package resolving. Will set the current attributes into the new strategy.- Specified by:
setResolverStrategy
in interfaceXMLClassDescriptorResolver
- Parameters:
resolverStrategy
- the ResolverStrategy to use for resolve calls
-
resolve
Returns the ClassDescriptor for the given class.- Specified by:
resolve
in interfaceClassDescriptorResolver
- Parameters:
type
- the Class to find the ClassDescriptor for- Returns:
- the ClassDescriptor for the given class
- Throws:
ResolverException
-
resolve
Returns the XMLClassDescriptor for the given class name.- Specified by:
resolve
in interfaceXMLClassDescriptorResolver
- Parameters:
className
- the class name to find the XMLClassDescriptor for- Returns:
- the XMLClassDescriptor for the given class name
- Throws:
ResolverException
- in case that resolving fails unrecoverable
-
resolve
Returns the XMLClassDescriptor for the given class name.- Specified by:
resolve
in interfaceXMLClassDescriptorResolver
- Parameters:
className
- the class name to find the XMLClassDescriptor forloader
- the ClassLoader to use- Returns:
- the XMLClassDescriptor for the given class name
- Throws:
ResolverException
- in case that resolving fails unrecoverable
-
resolveByXMLName
Returns the first XMLClassDescriptor that matches the given XML name and namespaceURI. Null is returned if no descriptor can be found.- Specified by:
resolveByXMLName
in interfaceXMLClassDescriptorResolver
- Parameters:
xmlName
- The class name to find the XMLClassDescriptor for.namespaceURI
- The namespace URI to identify the XMLClassDescriptor.loader
- The ClassLoader to use.- Returns:
- The XMLClassDescriptor for the given XML name.
-
resolveAllByXMLName
public Iterator<ClassDescriptor> resolveAllByXMLName(String xmlName, String namespaceURI, ClassLoader loader) Returns an enumeration of XMLClassDescriptor objects that match the given xml name.- Specified by:
resolveAllByXMLName
in interfaceXMLClassDescriptorResolver
- Parameters:
xmlName
- The class name to find the XMLClassDescriptor for.namespaceURI
- The namespace URI to identify the XMLClassDescriptor.loader
- The ClassLoader to use.- Returns:
- An Iterator of XMLClassDescriptor objects.
-
addClass
Loads the class descriptor for the class instance specified. The use of this method is useful when no mapping is used, as happens when the domain classes hase been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).- Specified by:
addClass
in interfaceXMLClassDescriptorResolver
- Parameters:
className
- Name of the class for which the associated descriptor should be loaded.- Throws:
ResolverException
- If there's an unrecoverable problem with resolving a certain class.
-
addClasses
Loads the class descriptors for the class instances specified. The use of this method is useful when no mapping is used, as happens when the domain classes hase been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).- Specified by:
addClasses
in interfaceXMLClassDescriptorResolver
- Parameters:
classNames
- Names of the classes for which the associated descriptors should be loaded.- Throws:
ResolverException
- If there's an unrecoverable problem with resolving a certain class.
-
addClass
Loads the class descriptor for the class instance specified. The use of this method is useful when no mapping is used, as happens when the domain classes have been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).- Specified by:
addClass
in interfaceXMLClassDescriptorResolver
- Parameters:
clazz
- Class for which the associated descriptor should be loaded.- Throws:
ResolverException
- If there's an unrecoverable problem with resolving a certain class.
-
addClasses
Loads the class descriptors for the class instances specified. The use of this method is useful when no mapping is used, as happens when the domain classes hase been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).- Specified by:
addClasses
in interfaceXMLClassDescriptorResolver
- Parameters:
clazzes
- Classes for which the associated descriptors should be loaded.- Throws:
ResolverException
- If there's an unrecoverable problem with resolving a certain class.
-
addPackage
Loads class descriptors from the package specified. The use of this method is useful when no mapping is used, as happens when the domain classes hase been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).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).
- Specified by:
addPackage
in interfaceXMLClassDescriptorResolver
- Parameters:
packageName
- The package name for the (descriptor) classes- Throws:
ResolverException
- If there's a problem loading class descriptors for the given package.
-
addPackages
Loads class descriptors from the packages specified. The use of this method is useful when no mapping is used, as happens when the domain classes hase been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).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).
- Specified by:
addPackages
in interfaceXMLClassDescriptorResolver
- Parameters:
packageNames
- The package names for the (descriptor) classes- Throws:
ResolverException
- If there's a problem loading class descriptors for the given package.
-
loadClassDescriptors
Deprecated.Loads class descriptors from the package specified. The use of this method is useful when no mapping is used, as happens when the domain classes hase been generated using the XML code generator (in which case instead of a mapping file class descriptor files will be generated).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).
- Specified by:
loadClassDescriptors
in interfaceXMLClassDescriptorResolver
- Parameters:
packageName
- The package name for the (descriptor) classes- Throws:
ResolverException
- If there's a problem loading class descriptors for the given package.
-
cleanDescriptorCache
public void cleanDescriptorCache()Cleans the descriptor cache.- Specified by:
cleanDescriptorCache
in interfaceXMLClassDescriptorResolver
- See Also:
-