org.apache.maven.plugin.assembly.model
Class ModuleSet

java.lang.Object
  extended by org.apache.maven.plugin.assembly.model.ModuleSet
All Implemented Interfaces:
java.io.Serializable

public class ModuleSet
extends java.lang.Object
implements java.io.Serializable

A moduleSet represent one or more project <module> present inside a project's pom.xml. This allows you to include sources or binaries belonging to a project's <modules>.
NOTE: When using <moduleSets> from the command-line, it is required to pass first the package phase by doing: "mvn package assembly:assembly". This bug/issue is scheduled to be addressed by Maven 2.1.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
ModuleSet()
           
 
Method Summary
 void addExclude(java.lang.String string)
          Method addExclude.
 void addInclude(java.lang.String string)
          Method addInclude.
 ModuleBinaries getBinaries()
          Get when this is present, the plugin will include the binaries of the included modules from this set in the resulting assembly.
 java.util.List getExcludes()
          Method getExcludes.
 java.util.List getIncludes()
          Method getIncludes.
 ModuleSources getSources()
          Get when this is present, the plugin will include the source files of the included modules from this set in the resulting assembly.
 boolean isIncludeSubModules()
          Get if set to false, the plugin will exclude sub-modules from processing in this ModuleSet.
 void removeExclude(java.lang.String string)
          Method removeExclude.
 void removeInclude(java.lang.String string)
          Method removeInclude.
 void setBinaries(ModuleBinaries binaries)
          Set when this is present, the plugin will include the binaries of the included modules from this set in the resulting assembly.
 void setExcludes(java.util.List excludes)
          Set this is a list of <exclude/> subelements, each containing a module reference of the type groupId:artifactId.
 void setIncludes(java.util.List includes)
          Set this is a list of <include/> subelements, each containing a module reference of the type groupId:artifactId.
 void setIncludeSubModules(boolean includeSubModules)
          Set if set to false, the plugin will exclude sub-modules from processing in this ModuleSet.
 void setSources(ModuleSources sources)
          Set when this is present, the plugin will include the source files of the included modules from this set in the resulting assembly.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModuleSet

public ModuleSet()
Method Detail

addExclude

public void addExclude(java.lang.String string)
Method addExclude.

Parameters:
string -

addInclude

public void addInclude(java.lang.String string)
Method addInclude.

Parameters:
string -

getBinaries

public ModuleBinaries getBinaries()
Get when this is present, the plugin will include the binaries of the included modules from this set in the resulting assembly.

Returns:
ModuleBinaries

getExcludes

public java.util.List getExcludes()
Method getExcludes.

Returns:
List

getIncludes

public java.util.List getIncludes()
Method getIncludes.

Returns:
List

getSources

public ModuleSources getSources()
Get when this is present, the plugin will include the source files of the included modules from this set in the resulting assembly.

Returns:
ModuleSources

isIncludeSubModules

public boolean isIncludeSubModules()
Get if set to false, the plugin will exclude sub-modules from processing in this ModuleSet. Otherwise, it will process all sub-modules, each subject to include/exclude rules. Default value is true. (Since 2.2).

Returns:
boolean

removeExclude

public void removeExclude(java.lang.String string)
Method removeExclude.

Parameters:
string -

removeInclude

public void removeInclude(java.lang.String string)
Method removeInclude.

Parameters:
string -

setBinaries

public void setBinaries(ModuleBinaries binaries)
Set when this is present, the plugin will include the binaries of the included modules from this set in the resulting assembly.

Parameters:
binaries -

setExcludes

public void setExcludes(java.util.List excludes)
Set this is a list of <exclude/> subelements, each containing a module reference of the type groupId:artifactId. Modules matching these elements will be excluded from this set.

Parameters:
excludes -

setIncludeSubModules

public void setIncludeSubModules(boolean includeSubModules)
Set if set to false, the plugin will exclude sub-modules from processing in this ModuleSet. Otherwise, it will process all sub-modules, each subject to include/exclude rules. Default value is true. (Since 2.2).

Parameters:
includeSubModules -

setIncludes

public void setIncludes(java.util.List includes)
Set this is a list of <include/> subelements, each containing a module reference of the type groupId:artifactId. Modules matching these elements will be included in this set. If none is present, then <includes> represents all valid values.

Parameters:
includes -

setSources

public void setSources(ModuleSources sources)
Set when this is present, the plugin will include the source files of the included modules from this set in the resulting assembly.

Parameters:
sources -


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.