org.apache.maven.plugin.assembly.model
Class DependencySet

java.lang.Object
  extended by org.apache.maven.plugin.assembly.model.SetBase
      extended by org.apache.maven.plugin.assembly.model.DependencySet
All Implemented Interfaces:
java.io.Serializable

public class DependencySet
extends SetBase
implements java.io.Serializable

A dependencySet allows inclusion and exclusion of project dependencies in the assembly.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
DependencySet()
           
 
Method Summary
 java.lang.String getModelEncoding()
           
 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 isUseTransitiveFiltering()
          Get Determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact.
 void setModelEncoding(java.lang.String modelEncoding)
           
 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 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.
 
Methods inherited from class org.apache.maven.plugin.assembly.model.SetBase
addExclude, addInclude, getDirectoryMode, getExcludes, getFileMode, getIncludes, getOutputDirectory, isUseDefaultExcludes, isUseStrictFiltering, removeExclude, removeInclude, setDirectoryMode, setExcludes, setFileMode, setIncludes, setOutputDirectory, setUseDefaultExcludes, setUseStrictFiltering
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DependencySet

public DependencySet()
Method Detail

getOutputFileNameMapping

public java.lang.String getOutputFileNameMapping()
Get Sets the mapping pattern for all dependencies included in this assembly. Default is ${artifactId}-${version}${dashClassifier?}.${extension}. If the artifact doesn't have a classifier, that part of the pattern will be left off.


getScope

public java.lang.String getScope()
Get Sets the dependency scope for this dependencySet. Default scope value is "runtime".


getUnpackOptions

public UnpackOptions getUnpackOptions()
Get Allows the specification of includes and excludes, along with filtering options, for items unpacked from a dependency artifact.


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 includes as archives (jars). Default value is false.


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)


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)


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)


setOutputFileNameMapping

public void setOutputFileNameMapping(java.lang.String outputFileNameMapping)
Set Sets the mapping pattern for all dependencies included in this assembly. Default is ${artifactId}-${version}${dashClassifier?}.${extension}. If the artifact doesn't have a classifier, that part of the pattern will be left off.

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 includes as archives (jars). 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.

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 -

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 -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)
Overrides:
setModelEncoding in class SetBase

getModelEncoding

public java.lang.String getModelEncoding()
Overrides:
getModelEncoding in class SetBase


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.