Class ModuleBinaries

java.lang.Object
org.apache.maven.plugins.assembly.model.ModuleBinaries
All Implemented Interfaces:
Serializable

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

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

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Method addDependencySet.
    void
    Method addExclude.
    void
    Method addInclude.
    Get when specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact.
    Method getDependencySets.
    Get similar to a UNIX permission, sets the directory mode of the directories included.
    Method getExcludes.
    Get similar to a UNIX permission, sets the file mode of the files included.
    Method getIncludes.
    Get sets the output directory relative to the root of the root directory of the assembly.
    Get sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly.
    Get allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact.
    boolean
    Get if set to true, the plugin will include the direct and transitive dependencies of of the project modules included here.
    boolean
    Get if set to true, this property will unpack all module packages into the specified output directory.
    void
    Method removeDependencySet.
    void
    Method removeExclude.
    void
    Method removeInclude.
    void
    setAttachmentClassifier(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
    Set specifies which dependencies of the module to include in the assembly.
    void
    setDirectoryMode(String directoryMode)
    Set similar to a UNIX permission, sets the directory mode of the directories included.
    void
    setExcludes(List<String> excludes)
    Set when <exclude> subelements are present, they define a set of dependency artifact coordinates to exclude.
    void
    setFileMode(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(List<String> includes)
    Set when <include> subelements are present, they define a set of artifact coordinates to include.
    void
    setOutputDirectory(String outputDirectory)
    Set sets the output directory relative to the root of the root directory of the assembly.
    void
    setOutputFileNameMapping(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
    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 Details

    • outputDirectory

      private 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 List<String> includes
      Field includes.
    • excludes

      private List<String> excludes
      Field excludes.
    • fileMode

      private 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 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 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 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 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 Details

    • ModuleBinaries

      public ModuleBinaries()
  • Method Details

    • addDependencySet

      public void addDependencySet(DependencySet dependencySet)
      Method addDependencySet.
      Parameters:
      dependencySet - a dependencySet object.
    • 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.
    • getAttachmentClassifier

      public 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 List<DependencySet> getDependencySets()
      Method getDependencySets.
      Returns:
      List
    • getDirectoryMode

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

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

      public 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 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 - a dependencySet object.
    • 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.
    • setAttachmentClassifier

      public void setAttachmentClassifier(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 - a attachmentClassifier object.
    • setDependencySets

      public void setDependencySets(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 - a dependencySets object.
    • setDirectoryMode

      public void setDirectoryMode(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 - a directoryMode object.
    • setExcludes

      public void setExcludes(List<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 - a excludes object.
    • setFileMode

      public void setFileMode(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 - a fileMode object.
    • 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 - a includeDependencies object.
    • setIncludes

      public void setIncludes(List<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 - a includes object.
    • setOutputDirectory

      public void setOutputDirectory(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 - a outputDirectory object.
    • setOutputFileNameMapping

      public void setOutputFileNameMapping(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 - a outputFileNameMapping object.
    • 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 - a unpack object.
    • 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 - a unpackOptions object.