org.exolab.castor.mapping.loader
Class AbstractMappingLoader2

java.lang.Object
  org.exolab.castor.mapping.loader.AbstractMappingLoader2

All Implemented Interfaces:

MappingLoader

Direct Known Subclasses:

AbstractMappingLoader

public abstract class AbstractMappingLoader2
extends Object
implements MappingLoader

Constructor Summary

AbstractMappingLoader2(ClassLoader loader)

Method Summary

protected void	addDescriptor(ClassDescriptor descriptor) Adds a class descriptor.
void	clear()
Iterator<ClassDescriptor>	descriptorIterator() Returns an iterator over all the known descriptors in the original order they have been added.
ClassLoader	getClassLoader() Returns the class loader associated with this mapping loader if one was specified.
ClassDescriptor	getDescriptor(String classname) Returns the ClassDescriptor for the class with the given name.
List<ClassDescriptor>	getDescriptors() Returns a List of ClassDescriptors of all known descriptors.
boolean	isAllowRedefinition() Is the ability to allow redefinitions enabled or disabled?
protected boolean	loadMapping() Return if mapping should be loaded with this MappingLoader instance or if another mapping have been loaded previously.
void	setAllowRedefinitions(boolean allow) Enables or disables the ability to allow the redefinition of class mappings.
void	setClassLoader(ClassLoader loader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.exolab.castor.mapping.MappingLoader

getBindingType, getSourceType

Constructor Detail

AbstractMappingLoader2

public AbstractMappingLoader2(ClassLoader loader)

Method Detail

clear

public final void clear()

Specified by:

clear in interface MappingLoader

setClassLoader

public final void setClassLoader(ClassLoader loader)

Specified by:

setClassLoader in interface MappingLoader

See Also:

{@inheritDoc}

getClassLoader

public final ClassLoader getClassLoader()

Description copied from interface: MappingLoader

Returns the class loader associated with this mapping loader if one was specified. This is the class loader used to load all the classes mapped by this mapping loader. May be null if no class loader was specified or in certain JVMs.

Specified by:

getClassLoader in interface MappingLoader

See Also:

{@inheritDoc}

setAllowRedefinitions

public final void setAllowRedefinitions(boolean allow)

Enables or disables the ability to allow the redefinition of class mappings.

Parameters:

allow - A boolean that when true enables redefinitions.

isAllowRedefinition

public final boolean isAllowRedefinition()

Is the ability to allow redefinitions enabled or disabled?

Returns:

A boolean that when true enables redefinitions.

addDescriptor

protected final void addDescriptor(ClassDescriptor descriptor)
                            throws MappingException

Adds a class descriptor. Will throw a mapping exception if a descriptor for this class already exists.

Parameters:

descriptor - The descriptor to add.

Throws:

MappingException - A descriptor for this class already exists.

getDescriptor

public final ClassDescriptor getDescriptor(String classname)

Description copied from interface: MappingLoader

Returns the ClassDescriptor for the class with the given name. If no such ClassDescriptor exists, within the set of mappings for this MappingLoader, null will be returned.

Specified by:

getDescriptor in interface MappingLoader

Parameters:

classname - The className for which to return the associated ClassDescriptor.

Returns:

The ClassDescriptor or null if not found.

See Also:

{@inheritDoc}

descriptorIterator

public final Iterator<ClassDescriptor> descriptorIterator()

Description copied from interface: MappingLoader

Returns an iterator over all the known descriptors in the original order they have been added. Each element is of type ClassDescriptor.

Specified by:

descriptorIterator in interface MappingLoader

See Also:

{@inheritDoc}

getDescriptors

public final List<ClassDescriptor> getDescriptors()

Description copied from interface: MappingLoader

Returns a List of ClassDescriptors of all known descriptors.

Specified by:

getDescriptors in interface MappingLoader

Returns:

List of ClassDescriptor

loadMapping

protected final boolean loadMapping()

Return if mapping should be loaded with this MappingLoader instance or if another mapping have been loaded previously. If no mapping have been loaded previously then prevent any other mapping to be loaded later on.

Returns:

true if mapping should be loaded, false otherwise.