Package org.apache.maven.plugins.assembly.model

Class ModuleSet

  • All Implemented Interfaces:
    Serializable
    public class ModuleSet
extends Object
implements 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 Detail

      • ModuleSet

        public ModuleSet()

    • Method Detail

      • addExclude

        public void addExclude​(String string)
        Method addExclude.
        Parameters:
        string - a string object.

      • addInclude

        public void addInclude​(String string)
        Method addInclude.
        Parameters:
        string - a string object.

      • 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 List<String> getExcludes()
        Method getExcludes.
        Returns:
        List

      • getIncludes

        public List<String> 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

      • isUseAllReactorProjects

        public boolean isUseAllReactorProjects()
        Get if set to true, the plugin will include all projects in the current reactor for processing in this ModuleSet. These will be subject to include/exclude rules. Default value is true. (Since 2.2).
        Returns:
        boolean

      • removeExclude

        public void removeExclude​(String string)
        Method removeExclude.
        Parameters:
        string - a string object.

      • removeInclude

        public void removeInclude​(String string)
        Method removeInclude.
        Parameters:
        string - a string object.

      • 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 - a binaries object.

      • setExcludes

        public void setExcludes​(List<String> excludes)
        Set when <exclude> subelements are present, they define a set of project artifact coordinates to exclude. If none is present, then <excludes> represents no exclusions. Artifact coordinates may be given in simple groupId:artifactId form, or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version. Additionally, wildcards can be used, as in *:maven-*.
        Parameters:
        excludes - a excludes object.

      • 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 - a includeSubModules object.

      • setIncludes

        public void setIncludes​(List<String> includes)
        Set when <include> subelements are present, they define a set of project coordinates to include. If none is present, then <includes> represents all valid values. Artifact coordinates may be given in simple groupId:artifactId form, or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version. Additionally, wildcards can be used, as in *:maven-*.
        Parameters:
        includes - a includes object.

      • 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 - a sources object.

      • setUseAllReactorProjects

        public void setUseAllReactorProjects​(boolean useAllReactorProjects)
        Set if set to true, the plugin will include all projects in the current reactor for processing in this ModuleSet. These will be subject to include/exclude rules. Default value is true. (Since 2.2).
        Parameters:
        useAllReactorProjects - a useAllReactorProjects object.