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

Class ModuleDescriptor

java.lang.Object

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

public final class ModuleDescriptor
extends Object

Holds the information of one module descriptor. The descriptor controls the process of generating JBoss modules in a folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleDescriptor.Builder Builds instances of ModuleDescriptor.

Method Summary

Modifier and Type	Method and Description
void	applySlot(String slot) Sets the slot to the given value, if the slot is not set.
static ModuleDescriptor	copy(String name, ModuleDescriptor originalModule) Creates a shallow copy of the module descriptor.
static ModuleDescriptor	create(String name) Creates a module with a given name.
boolean	equals(Object object)
ApplyToDependencies	getApplyToDependencies() Returns the information that has to be applied to dependencies if the matcher matches the name of a module.
ApplyToModule	getApplyToModule() Returns the module information to be applied to the generated module.
Directives	getDirectives() Returns the directives for this module.
ArtifactMatcher	getMatcher() Returns the artifact matcher to define the rules for matching artifacts to be included as resources to a module.
String	getName() Returns the name of the module.
String	getSlot() Returns the name of the slot this module is part of.
int	hashCode()
MatchContext	match(org.eclipse.aether.artifact.Artifact artifact) Checks if the given artifact matches the module descriptor.
void	merge(ModuleDescriptor moduleDescriptor) Merges the dependencies, properties, port and export of the given module descriptor with this one.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

copy

public static ModuleDescriptor copy(String name,
                                    ModuleDescriptor originalModule)

Creates a shallow copy of the module descriptor.

Parameters:

name - the name of the module.

originalModule - the descriptor to shallow copy.

Returns:

the shallow copy.

create

public static ModuleDescriptor create(String name)

Creates a module with a given name.

Parameters:

name - the name of the module.

Returns:

the new instance.

getName

public String getName()

Returns the name of the module.

Returns:

the name of the module.

getSlot

public String getSlot()

Returns the name of the slot this module is part of. May be null.

Returns:

the name of the slot this module is part of.

getDirectives

public Directives getDirectives()

Returns the directives for this module. Directives control the building process of this module.

Returns:

the directives for this module.

getMatcher

public ArtifactMatcher getMatcher()

Returns the artifact matcher to define the rules for matching artifacts to be included as resources to a module.

Returns:

the artifact matcher to define the rules for matching artifacts to be included as resources to a module.

getApplyToDependencies

public ApplyToDependencies getApplyToDependencies()

Returns the information that has to be applied to dependencies if the matcher matches the name of a module.

Returns:

the information that has to be applied to dependencies if the matcher matches the name of a module.

getApplyToModule

public ApplyToModule getApplyToModule()

Returns the module information to be applied to the generated module.

Returns:

the module information to be applied to the generated module.

applySlot

public void applySlot(String slot)

Sets the slot to the given value, if the slot is not set.

Parameters:

slot - the slot to set.

match

public MatchContext match(org.eclipse.aether.artifact.Artifact artifact)

Checks if the given artifact matches the module descriptor.

Parameters:

artifact - the artifact to match.

Returns:

true if the module descriptor matches the given artifact, false otherwise.

merge

public void merge(ModuleDescriptor moduleDescriptor)
           throws NullPointerException,
                  IllegalArgumentException

Merges the dependencies, properties, port and export of the given module descriptor with this one.

Parameters:

moduleDescriptor - the module descriptor to merge with this instance.

Throws:

NullPointerException - if moduleDescriptor is null.

IllegalArgumentException - if the module descriptor is illegal to be merged.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Provides the properties via reflection for displaying debug information.

Overrides:

toString in class Object