Class 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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private ModuleBinaries binaries
      When this is present, the plugin will include the binaries of the included modules from this set in the resulting assembly.
      private java.util.List<java.lang.String> excludes
      Field excludes.
      private java.util.List<java.lang.String> includes
      Field includes.
      private boolean includeSubModules
      If set to false, the plugin will exclude sub-modules from processing in this ModuleSet.
      private ModuleSources sources
      When this is present, the plugin will include the source files of the included modules from this set in the resulting assembly.
      private boolean useAllReactorProjects
      If set to true, the plugin will include all projects in the current reactor for processing in this ModuleSet.
    • Constructor Summary

      Constructors 
      Constructor Description
      ModuleSet()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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<java.lang.String> getExcludes()
      Method getExcludes.
      java.util.List<java.lang.String> 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.
      boolean isUseAllReactorProjects()
      Get if set to true, the plugin will include all projects in the current reactor for 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<java.lang.String> excludes)
      Set when <exclude> subelements are present, they define a set of project artifact coordinates to exclude.
      void setIncludes​(java.util.List<java.lang.String> includes)
      Set when <include> subelements are present, they define a set of project coordinates to include.
      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.
      void setUseAllReactorProjects​(boolean useAllReactorProjects)
      Set if set to true, the plugin will include all projects in the current reactor for processing in this ModuleSet.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • useAllReactorProjects

        private boolean useAllReactorProjects
        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) .
      • includeSubModules

        private boolean includeSubModules
        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) .
      • includes

        private java.util.List<java.lang.String> includes
        Field includes.
      • excludes

        private java.util.List<java.lang.String> excludes
        Field excludes.
      • sources

        private ModuleSources sources
        When this is present, the plugin will include the source files of the included modules from this set in the resulting assembly.
      • binaries

        private ModuleBinaries binaries
        When this is present, the plugin will include the binaries of the included modules from this set in the resulting assembly.
    • Constructor Detail

      • ModuleSet

        public ModuleSet()
    • Method Detail

      • addExclude

        public void addExclude​(java.lang.String string)
        Method addExclude.
        Parameters:
        string - a string object.
      • addInclude

        public void addInclude​(java.lang.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 java.util.List<java.lang.String> getExcludes()
        Method getExcludes.
        Returns:
        List
      • getIncludes

        public java.util.List<java.lang.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​(java.lang.String string)
        Method removeExclude.
        Parameters:
        string - a string object.
      • removeInclude

        public void removeInclude​(java.lang.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​(java.util.List<java.lang.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​(java.util.List<java.lang.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.