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

Class ModuleDescriptor.Builder

java.lang.Object

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

Enclosing class:

ModuleDescriptor

public static final class ModuleDescriptor.Builder
extends java.lang.Object

Builds instances of ModuleDescriptor.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ModuleDescriptor	build() Builds instances of ModuleDescriptor.
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.
java.lang.String	getName() Returns the name of the module.
java.lang.String	getSlot() Returns the name of the slot this module is part of.
ModuleDescriptor.Builder	with(ApplyToDependencies applyToDependencies) Sets the information that has to be applied to dependencies if the matcher matches the name of a module.
ModuleDescriptor.Builder	with(ApplyToModule applyToModule) Sets the module information to be applied to the generated module.
ModuleDescriptor.Builder	with(ArtifactMatcher matcher) Sets the artifact matcher to define the rules for matching artifacts to be included as resources to a module.
ModuleDescriptor.Builder	with(Directives directives) Sets the directives for this module.
ModuleDescriptor.Builder	withName(java.lang.String name) Sets the name of the module.
ModuleDescriptor.Builder	withSlot(java.lang.String slot) Sets the name of the slot this module is part of.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withName

public ModuleDescriptor.Builder withName(java.lang.String name)

Sets the name of the module.

Parameters:

name - the name of the module.

Returns:

a reference on this builder.

withSlot

public ModuleDescriptor.Builder withSlot(java.lang.String slot)

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

Parameters:

slot - the name of the slot this module is part of.

Returns:

a reference on this builder.

with

public ModuleDescriptor.Builder with(Directives directives)

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

Parameters:

directives - the directives for this module.

Returns:

a reference on this builder.

with

public ModuleDescriptor.Builder with(ArtifactMatcher matcher)

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

Parameters:

matcher - the dependency matcher for resources.

Returns:

a reference on this builder.

with

public ModuleDescriptor.Builder with(ApplyToDependencies applyToDependencies)

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

Parameters:

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

Returns:

a reference on this builder.

with

public ModuleDescriptor.Builder with(ApplyToModule applyToModule)

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

Parameters:

applyToModule - the module information to be applied to the generated module.

Returns:

a reference on this builder.

getName

public java.lang.String getName()

Returns the name of the module.

Returns:

the name of the module.

getSlot

public java.lang.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.

build

public ModuleDescriptor build()
                       throws java.lang.NullPointerException,
                              java.lang.IllegalArgumentException

Builds instances of ModuleDescriptor.

Returns:

the new instance.

Throws:

java.lang.NullPointerException - if any required builder property is null.

java.lang.IllegalArgumentException - if any builder property is not validated successfully.