Class DependencySet
- java.lang.Object
-
- org.apache.maven.plugins.assembly.model.DependencySet
-
- All Implemented Interfaces:
java.io.Serializable
public class DependencySet extends java.lang.Object implements java.io.Serializable
A dependencySet allows inclusion and exclusion of project dependencies in the assembly.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description 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 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 dependencies included in this assembly.private java.lang.String
scope
Sets the dependency scope for this dependencySet.private boolean
unpack
If set to true, this property will unpack all dependencies into the specified output directory.private UnpackOptions
unpackOptions
Allows the specification of includes and excludes, along with filtering options, for items unpacked from a dependency artifact.private boolean
useProjectArtifact
Determines whether the artifact produced during the current project's build should be included in this dependency set.private boolean
useProjectAttachments
Determines whether the attached artifacts produced during the current project's build should be included in this dependency set.private boolean
useStrictFiltering
When specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error.private boolean
useTransitiveDependencies
Determines whether transitive dependencies will be included in the processing of the current dependency set.private boolean
useTransitiveFiltering
Determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact.
-
Constructor Summary
Constructors Constructor Description DependencySet()
-
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.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 dependencies included in this assembly.java.lang.String
getScope()
Get sets the dependency scope for this dependencySet.UnpackOptions
getUnpackOptions()
Get allows the specification of includes and excludes, along with filtering options, for items unpacked from a dependency artifact.boolean
isUnpack()
Get if set to true, this property will unpack all dependencies into the specified output directory.boolean
isUseProjectArtifact()
Get determines whether the artifact produced during the current project's build should be included in this dependency set.boolean
isUseProjectAttachments()
Get determines whether the attached artifacts produced during the current project's build should be included in this dependency set.boolean
isUseStrictFiltering()
Get when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error.boolean
isUseTransitiveDependencies()
Get determines whether transitive dependencies will be included in the processing of the current dependency set.boolean
isUseTransitiveFiltering()
Get determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact.void
removeExclude(java.lang.String string)
Method removeExclude.void
removeInclude(java.lang.String string)
Method removeInclude.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
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 dependencies included in this assembly.void
setScope(java.lang.String scope)
Set sets the dependency scope for this dependencySet.void
setUnpack(boolean unpack)
Set if set to true, this property will unpack all dependencies 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 dependency artifact.void
setUseProjectArtifact(boolean useProjectArtifact)
Set determines whether the artifact produced during the current project's build should be included in this dependency set.void
setUseProjectAttachments(boolean useProjectAttachments)
Set determines whether the attached artifacts produced during the current project's build should be included in this dependency set.void
setUseStrictFiltering(boolean useStrictFiltering)
Set when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error.void
setUseTransitiveDependencies(boolean useTransitiveDependencies)
Set determines whether transitive dependencies will be included in the processing of the current dependency set.void
setUseTransitiveFiltering(boolean useTransitiveFiltering)
Set determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact.
-
-
-
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)
-
useStrictFiltering
private boolean useStrictFiltering
When specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error. This is meant to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor is incorrectly configured. (Since 2.2) .
-
outputFileNameMapping
private java.lang.String outputFileNameMapping
Sets the mapping pattern for all dependencies included in this assembly. Default is ${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.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.
-
unpack
private boolean unpack
If set to true, this property will unpack all dependencies into the specified output directory. When set to false, dependencies will be included as archives (jars). Can only unpack jar, zip, tar.gz, and tar.bz archives. Default value is false.
-
unpackOptions
private UnpackOptions unpackOptions
Allows the specification of includes and excludes, along with filtering options, for items unpacked from a dependency artifact. (Since 2.2) .
-
scope
private java.lang.String scope
Sets the dependency scope for this dependencySet. Default scope value is "runtime".
-
useProjectArtifact
private boolean useProjectArtifact
Determines whether the artifact produced during the current project's build should be included in this dependency set. Default value is true, for backward compatibility. (Since 2.2) .
-
useProjectAttachments
private boolean useProjectAttachments
Determines whether the attached artifacts produced during the current project's build should be included in this dependency set. Default value is false. (Since 2.2) .
-
useTransitiveDependencies
private boolean useTransitiveDependencies
Determines whether transitive dependencies will be included in the processing of the current dependency set. If true, includes/excludes/useTransitiveFiltering will apply to transitive dependency artifacts in addition to the main project dependency artifacts. If false, useTransitiveFiltering is meaningless, and includes/excludes only affect the immediate dependencies of the project. By default, this value is true. (Since 2.2) .
-
useTransitiveFiltering
private boolean useTransitiveFiltering
Determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact. If true, and the current artifact is a transitive dependency brought in by another artifact which matches an inclusion or exclusion pattern, then the current artifact has the same inclusion/exclusion logic applied to it as well. By default, this value is false, in order to preserve backward compatibility with version 2.1. This means that includes/excludes only apply directly to the current artifact, and not to the transitive set of artifacts which brought it in. (Since 2.2) .
-
-
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
-
-
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 dependencies included in this assembly. Default is ${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.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
-
getScope
public java.lang.String getScope()
Get sets the dependency scope for this dependencySet. Default scope value is "runtime".- Returns:
- String
-
getUnpackOptions
public UnpackOptions getUnpackOptions()
Get allows the specification of includes and excludes, along with filtering options, for items unpacked from a dependency artifact. (Since 2.2).- Returns:
- UnpackOptions
-
isUnpack
public boolean isUnpack()
Get if set to true, this property will unpack all dependencies into the specified output directory. When set to false, dependencies will be included as archives (jars). Can only unpack jar, zip, tar.gz, and tar.bz archives. Default value is false.- Returns:
- boolean
-
isUseProjectArtifact
public boolean isUseProjectArtifact()
Get determines whether the artifact produced during the current project's build should be included in this dependency set. Default value is true, for backward compatibility. (Since 2.2).- Returns:
- boolean
-
isUseProjectAttachments
public boolean isUseProjectAttachments()
Get determines whether the attached artifacts produced during the current project's build should be included in this dependency set. Default value is false. (Since 2.2).- Returns:
- boolean
-
isUseStrictFiltering
public boolean isUseStrictFiltering()
Get when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error. This is meant to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor is incorrectly configured. (Since 2.2).- Returns:
- boolean
-
isUseTransitiveDependencies
public boolean isUseTransitiveDependencies()
Get determines whether transitive dependencies will be included in the processing of the current dependency set. If true, includes/excludes/useTransitiveFiltering will apply to transitive dependency artifacts in addition to the main project dependency artifacts. If false, useTransitiveFiltering is meaningless, and includes/excludes only affect the immediate dependencies of the project. By default, this value is true. (Since 2.2).- Returns:
- boolean
-
isUseTransitiveFiltering
public boolean isUseTransitiveFiltering()
Get determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact. If true, and the current artifact is a transitive dependency brought in by another artifact which matches an inclusion or exclusion pattern, then the current artifact has the same inclusion/exclusion logic applied to it as well. By default, this value is false, in order to preserve backward compatibility with version 2.1. This means that includes/excludes only apply directly to the current artifact, and not to the transitive set of artifacts which brought it in. (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
-
-
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
-
-
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 dependencies included in this assembly. Default is ${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.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
-
-
setScope
public void setScope(java.lang.String scope)
Set sets the dependency scope for this dependencySet. Default scope value is "runtime".- Parameters:
scope
-
-
setUnpack
public void setUnpack(boolean unpack)
Set if set to true, this property will unpack all dependencies into the specified output directory. When set to false, dependencies will be included as archives (jars). Can only unpack jar, zip, tar.gz, and tar.bz archives. Default value is false.- 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 dependency artifact. (Since 2.2).- Parameters:
unpackOptions
-
-
setUseProjectArtifact
public void setUseProjectArtifact(boolean useProjectArtifact)
Set determines whether the artifact produced during the current project's build should be included in this dependency set. Default value is true, for backward compatibility. (Since 2.2).- Parameters:
useProjectArtifact
-
-
setUseProjectAttachments
public void setUseProjectAttachments(boolean useProjectAttachments)
Set determines whether the attached artifacts produced during the current project's build should be included in this dependency set. Default value is false. (Since 2.2).- Parameters:
useProjectAttachments
-
-
setUseStrictFiltering
public void setUseStrictFiltering(boolean useStrictFiltering)
Set when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error. This is meant to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor is incorrectly configured. (Since 2.2).- Parameters:
useStrictFiltering
-
-
setUseTransitiveDependencies
public void setUseTransitiveDependencies(boolean useTransitiveDependencies)
Set determines whether transitive dependencies will be included in the processing of the current dependency set. If true, includes/excludes/useTransitiveFiltering will apply to transitive dependency artifacts in addition to the main project dependency artifacts. If false, useTransitiveFiltering is meaningless, and includes/excludes only affect the immediate dependencies of the project. By default, this value is true. (Since 2.2).- Parameters:
useTransitiveDependencies
-
-
setUseTransitiveFiltering
public void setUseTransitiveFiltering(boolean useTransitiveFiltering)
Set determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact. If true, and the current artifact is a transitive dependency brought in by another artifact which matches an inclusion or exclusion pattern, then the current artifact has the same inclusion/exclusion logic applied to it as well. By default, this value is false, in order to preserve backward compatibility with version 2.1. This means that includes/excludes only apply directly to the current artifact, and not to the transitive set of artifacts which brought it in. (Since 2.2).- Parameters:
useTransitiveFiltering
-
-
-