Class ModuleBinaries

  • All Implemented Interfaces:
    java.io.Serializable

    public class ModuleBinaries
    extends java.lang.Object
    implements java.io.Serializable
    Contains configuration options for including the binary files of a project module in an assembly.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String attachmentClassifier
      When specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact.
      private java.util.List<DependencySet> dependencySets
      Field dependencySets.
      private java.lang.String directoryMode
      Similar to a UNIX permission, sets the directory mode of the directories included.
      private java.util.List<java.lang.String> excludes
      Field excludes.
      private java.lang.String fileMode
      Similar to a UNIX permission, sets the file mode of the files included.
      private boolean includeDependencies
      If set to true, the plugin will include the direct and transitive dependencies of of the project modules included here.
      private java.util.List<java.lang.String> includes
      Field includes.
      private java.lang.String outputDirectory
      Sets the output directory relative to the root of the root directory of the assembly.
      private java.lang.String outputFileNameMapping
      Sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly.
      private boolean unpack
      If set to true, this property will unpack all module packages into the specified output directory.
      private UnpackOptions unpackOptions
      Allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact.
    • Constructor Summary

      Constructors 
      Constructor Description
      ModuleBinaries()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addDependencySet​(DependencySet dependencySet)
      Method addDependencySet.
      void addExclude​(java.lang.String string)
      Method addExclude.
      void addInclude​(java.lang.String string)
      Method addInclude.
      java.lang.String getAttachmentClassifier()
      Get when specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact.
      java.util.List<DependencySet> getDependencySets()
      Method getDependencySets.
      java.lang.String getDirectoryMode()
      Get similar to a UNIX permission, sets the directory mode of the directories included.
      java.util.List<java.lang.String> getExcludes()
      Method getExcludes.
      java.lang.String getFileMode()
      Get similar to a UNIX permission, sets the file mode of the files included.
      java.util.List<java.lang.String> getIncludes()
      Method getIncludes.
      java.lang.String getOutputDirectory()
      Get sets the output directory relative to the root of the root directory of the assembly.
      java.lang.String getOutputFileNameMapping()
      Get sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly.
      UnpackOptions getUnpackOptions()
      Get allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact.
      boolean isIncludeDependencies()
      Get if set to true, the plugin will include the direct and transitive dependencies of of the project modules included here.
      boolean isUnpack()
      Get if set to true, this property will unpack all module packages into the specified output directory.
      void removeDependencySet​(DependencySet dependencySet)
      Method removeDependencySet.
      void removeExclude​(java.lang.String string)
      Method removeExclude.
      void removeInclude​(java.lang.String string)
      Method removeInclude.
      void setAttachmentClassifier​(java.lang.String attachmentClassifier)
      Set when specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact.
      void setDependencySets​(java.util.List<DependencySet> dependencySets)
      Set specifies which dependencies of the module to include in the assembly.
      void setDirectoryMode​(java.lang.String directoryMode)
      Set similar to a UNIX permission, sets the directory mode of the directories included.
      void setExcludes​(java.util.List<java.lang.String> excludes)
      Set when <exclude> subelements are present, they define a set of dependency artifact coordinates to exclude.
      void setFileMode​(java.lang.String fileMode)
      Set similar to a UNIX permission, sets the file mode of the files included.
      void setIncludeDependencies​(boolean includeDependencies)
      Set if set to true, the plugin will include the direct and transitive dependencies of of the project modules included here.
      void setIncludes​(java.util.List<java.lang.String> includes)
      Set when <include> subelements are present, they define a set of artifact coordinates to include.
      void setOutputDirectory​(java.lang.String outputDirectory)
      Set sets the output directory relative to the root of the root directory of the assembly.
      void setOutputFileNameMapping​(java.lang.String outputFileNameMapping)
      Set sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly.
      void setUnpack​(boolean unpack)
      Set if set to true, this property will unpack all module packages into the specified output directory.
      void setUnpackOptions​(UnpackOptions unpackOptions)
      Set allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact.
      • Methods inherited from class java.lang.Object

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

      • outputDirectory

        private java.lang.String outputDirectory
        Sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory, directly beneath the root of the archive.
      • includes

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

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

        private java.lang.String fileMode
        Similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. The default value is 0644. (more on unix-style permissions)
      • directoryMode

        private java.lang.String directoryMode
        Similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. The default value is 0755. (more on unix-style permissions)
      • attachmentClassifier

        private java.lang.String attachmentClassifier
        When specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact. If it can find an attached artifact matching the specified classifier, it will use it; otherwise, it will throw an exception. (Since 2.2) .
      • includeDependencies

        private boolean includeDependencies
        If set to true, the plugin will include the direct and transitive dependencies of of the project modules included here. Otherwise, it will only include the module packages only. Default value is true.
      • dependencySets

        private java.util.List<DependencySet> dependencySets
        Field dependencySets.
      • unpack

        private boolean unpack
        If set to true, this property will unpack all module packages into the specified output directory. When set to false module packages will be included as archives (jars). Default value is true.
      • unpackOptions

        private UnpackOptions unpackOptions
        Allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact. (Since 2.2) .
      • outputFileNameMapping

        private java.lang.String outputFileNameMapping
        Sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly. Default is ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases, use outputDirectory. See the plugin FAQ for more details about entries usable in the outputFileNameMapping parameter.
    • Constructor Detail

      • ModuleBinaries

        public ModuleBinaries()
    • Method Detail

      • addDependencySet

        public void addDependencySet​(DependencySet dependencySet)
        Method addDependencySet.
        Parameters:
        dependencySet -
      • addExclude

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

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

        public java.lang.String getAttachmentClassifier()
        Get when specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact. If it can find an attached artifact matching the specified classifier, it will use it; otherwise, it will throw an exception. (Since 2.2).
        Returns:
        String
      • getDependencySets

        public java.util.List<DependencySet> getDependencySets()
        Method getDependencySets.
        Returns:
        List
      • getDirectoryMode

        public java.lang.String getDirectoryMode()
        Get similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. The default value is 0755. (more on unix-style permissions)
        Returns:
        String
      • getExcludes

        public java.util.List<java.lang.String> getExcludes()
        Method getExcludes.
        Returns:
        List
      • getFileMode

        public java.lang.String getFileMode()
        Get similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. The default value is 0644. (more on unix-style permissions)
        Returns:
        String
      • getIncludes

        public java.util.List<java.lang.String> getIncludes()
        Method getIncludes.
        Returns:
        List
      • getOutputDirectory

        public java.lang.String getOutputDirectory()
        Get sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory, directly beneath the root of the archive.
        Returns:
        String
      • getOutputFileNameMapping

        public java.lang.String getOutputFileNameMapping()
        Get sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly. Default is ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases, use outputDirectory. See the plugin FAQ for more details about entries usable in the outputFileNameMapping parameter.
        Returns:
        String
      • getUnpackOptions

        public UnpackOptions getUnpackOptions()
        Get allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact. (Since 2.2).
        Returns:
        UnpackOptions
      • isIncludeDependencies

        public boolean isIncludeDependencies()
        Get if set to true, the plugin will include the direct and transitive dependencies of of the project modules included here. Otherwise, it will only include the module packages only. Default value is true.
        Returns:
        boolean
      • isUnpack

        public boolean isUnpack()
        Get if set to true, this property will unpack all module packages into the specified output directory. When set to false module packages will be included as archives (jars). Default value is true.
        Returns:
        boolean
      • removeDependencySet

        public void removeDependencySet​(DependencySet dependencySet)
        Method removeDependencySet.
        Parameters:
        dependencySet -
      • removeExclude

        public void removeExclude​(java.lang.String string)
        Method removeExclude.
        Parameters:
        string -
      • removeInclude

        public void removeInclude​(java.lang.String string)
        Method removeInclude.
        Parameters:
        string -
      • setAttachmentClassifier

        public void setAttachmentClassifier​(java.lang.String attachmentClassifier)
        Set when specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact. If it can find an attached artifact matching the specified classifier, it will use it; otherwise, it will throw an exception. (Since 2.2).
        Parameters:
        attachmentClassifier -
      • setDependencySets

        public void setDependencySets​(java.util.List<DependencySet> dependencySets)
        Set specifies which dependencies of the module to include in the assembly. A dependencySet is specified by providing one or more of <dependencySet> subelements. (Since 2.2).
        Parameters:
        dependencySets -
      • setDirectoryMode

        public void setDirectoryMode​(java.lang.String directoryMode)
        Set similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. The default value is 0755. (more on unix-style permissions)
        Parameters:
        directoryMode -
      • setExcludes

        public void setExcludes​(java.util.List<java.lang.String> excludes)
        Set when <exclude> subelements are present, they define a set of dependency 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 -
      • setFileMode

        public void setFileMode​(java.lang.String fileMode)
        Set similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. The default value is 0644. (more on unix-style permissions)
        Parameters:
        fileMode -
      • setIncludeDependencies

        public void setIncludeDependencies​(boolean includeDependencies)
        Set if set to true, the plugin will include the direct and transitive dependencies of of the project modules included here. Otherwise, it will only include the module packages only. Default value is true.
        Parameters:
        includeDependencies -
      • setIncludes

        public void setIncludes​(java.util.List<java.lang.String> includes)
        Set when <include> subelements are present, they define a set of artifact 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 -
      • setOutputDirectory

        public void setOutputDirectory​(java.lang.String outputDirectory)
        Set sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory, directly beneath the root of the archive.
        Parameters:
        outputDirectory -
      • setOutputFileNameMapping

        public void setOutputFileNameMapping​(java.lang.String outputFileNameMapping)
        Set sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly. Default is ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases, use outputDirectory. See the plugin FAQ for more details about entries usable in the outputFileNameMapping parameter.
        Parameters:
        outputFileNameMapping -
      • setUnpack

        public void setUnpack​(boolean unpack)
        Set if set to true, this property will unpack all module packages into the specified output directory. When set to false module packages will be included as archives (jars). Default value is true.
        Parameters:
        unpack -
      • setUnpackOptions

        public void setUnpackOptions​(UnpackOptions unpackOptions)
        Set allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact. (Since 2.2).
        Parameters:
        unpackOptions -