de.smartics.maven.plugin.jboss.modules.descriptor

Class ModulesDescriptor

java.lang.Object

de.smartics.maven.plugin.jboss.modules.descriptor.ModulesDescriptor

public final class ModulesDescriptor
extends java.lang.Object

Descriptor containing information on modules configurations. This information is parsed from module XML documents.

It basically contains module descriptors, but may also contain any meta data.

Constructor Summary

Constructors

Constructor and Description
ModulesDescriptor(java.lang.String modulesId) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addDescriptor(ModuleDescriptor descriptor) Adds the given descriptor to the list of module descriptors.
void	applyDefaultSlot(java.lang.String slot) Adds the given slot to all module descriptors that have not set their slots explicitly.
java.util.List<ModuleDescriptor>	getDescriptors() Returns the list of descriptors for modules.
java.lang.String	getModulesId() Returns the identifier of the set of modules.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModulesDescriptor

public ModulesDescriptor(java.lang.String modulesId)

Default constructor.

Parameters:

modulesId - the identifier of the set of modules. Used for error reporting mainly. Typically this is the system identifier of the XML file this descriptor is based on.

Method Detail

getModulesId

public java.lang.String getModulesId()

Returns the identifier of the set of modules. Used for error reporting mainly. Typically this is the system identifier of the XML file this descriptor is based on.

Returns:

the identifier of the set of modules.

addDescriptor

public void addDescriptor(ModuleDescriptor descriptor)
                   throws java.lang.NullPointerException

Adds the given descriptor to the list of module descriptors.

Parameters:

descriptor - the descriptor to add.

Throws:

java.lang.NullPointerException - if descriptor is null.

getDescriptors

public java.util.List<ModuleDescriptor> getDescriptors()

Returns the list of descriptors for modules.

Returns:

the list of descriptors for modules.

applyDefaultSlot

public void applyDefaultSlot(java.lang.String slot)

Adds the given slot to all module descriptors that have not set their slots explicitly.

Parameters:

slot - the slot to set.

toString

public java.lang.String toString()

Provides the properties via reflection for displaying debug information.

Overrides:

toString in class java.lang.Object