Class UnpackDependenciesMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugins.dependency.AbstractDependencyMojo
-
- org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo
-
- org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo
-
- org.apache.maven.plugins.dependency.fromDependencies.UnpackDependenciesMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled,org.apache.maven.plugin.Mojo
@Mojo(name="unpack-dependencies", requiresDependencyResolution=TEST, defaultPhase=PROCESS_SOURCES, threadSafe=true) public class UnpackDependenciesMojo extends AbstractFromDependenciesMojoGoal that unpacks the project dependencies from the repository to a defined location.- Since:
- 1.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.StringencodingEncoding of artifacts.private java.lang.StringexcludesA comma separated list of file patterns to exclude when unpacking the artifact.private java.lang.StringincludesA comma separated list of file patterns to include when unpacking the artifact.-
Fields inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo
failOnMissingClassifierArtifact, outputDirectory, stripClassifier, stripVersion, useRepositoryLayout, useSubDirectoryPerArtifact, useSubDirectoryPerScope, useSubDirectoryPerType
-
Fields inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo
classifier, excludeArtifactIds, excludeClassifiers, excludeGroupIds, excludeScope, excludeTransitive, excludeTypes, includeArtifactIds, includeClassifiers, includeGroupIds, includeScope, includeTypes, markersDirectory, overWriteIfNewer, overWriteReleases, overWriteSnapshots, prependGroupId, type
-
Fields inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo
outputAbsoluteArtifactFilename, reactorProjects, session
-
-
Constructor Summary
Constructors Constructor Description UnpackDependenciesMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voiddoExecute()Main entry into mojo.java.lang.StringgetEncoding()java.lang.StringgetExcludes()java.lang.StringgetIncludes()protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFiltergetMarkedArtifactFilter()Return anArtifactsFilterindicating which artifacts must be filtered out.voidsetEncoding(java.lang.String encoding)voidsetExcludes(java.lang.String excludes)voidsetIncludes(java.lang.String includes)-
Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo
getOutputDirectory, isFailOnMissingClassifierArtifact, isStripVersion, isUseRepositoryLayout, isUseSubDirectoryPerArtifact, isUseSubDirectoryPerScope, isUseSubDirectoryPerType, setFailOnMissingClassifierArtifact, setOutputDirectory, setStripVersion, setUseRepositoryLayout, setUseSubDirectoryPerArtifact, setUseSubDirectoryPerScope, setUseSubDirectoryPerType
-
Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo
filterMarkedDependencies, getArtifactResolver, getClassifierTranslatedDependencies, getDependencyResolver, getDependencySets, getDependencySets, getMarkersDirectory, getRepositoryManager, getResolvedDependencies, isPrependGroupId, resolve, setMarkersDirectory, setPrependGroupId
-
Methods inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo
copyFile, execute, getArchiverManager, getProject, isSilent, isSkip, isUseJvmChmod, newResolveArtifactProjectBuildingRequest, setArchiverManager, setSilent, setSkip, setUseJvmChmod, unpack, unpack, unpack
-
-
-
-
Field Detail
-
includes
@Parameter(property="mdep.unpack.includes") private java.lang.String includes
A comma separated list of file patterns to include when unpacking the artifact. i.e.**/*.xml,**/*.propertiesNOTE: Excludes patterns override the includes. (component code =return isIncluded( name ) AND !isExcluded( name );)- Since:
- 2.0
-
excludes
@Parameter(property="mdep.unpack.excludes") private java.lang.String excludes
A comma separated list of file patterns to exclude when unpacking the artifact. i.e.**/*.xml,**/*.propertiesNOTE: Excludes patterns override the includes. (component code =return isIncluded( name ) AND !isExcluded( name );)- Since:
- 2.0
-
encoding
@Parameter(property="mdep.unpack.encoding") private java.lang.String encoding
Encoding of artifacts.- Since:
- 3.0
-
-
Method Detail
-
doExecute
protected void doExecute() throws org.apache.maven.plugin.MojoExecutionExceptionMain entry into mojo. This method gets the dependencies and iterates through each one passing it to DependencyUtil.unpackFile().- Specified by:
doExecutein classAbstractDependencyMojo- Throws:
org.apache.maven.plugin.MojoExecutionException- with a message if an error occurs.- See Also:
AbstractDependencyFilterMojo.getDependencySets(boolean),AbstractDependencyMojo.unpack(Artifact, File, String)
-
getMarkedArtifactFilter
protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()
Description copied from class:AbstractDependencyFilterMojoReturn anArtifactsFilterindicating which artifacts must be filtered out.- Specified by:
getMarkedArtifactFilterin classAbstractDependencyFilterMojo- Returns:
- an
ArtifactsFilterindicating which artifacts must be filtered out.
-
getExcludes
public java.lang.String getExcludes()
- Returns:
- Returns a comma separated list of excluded items
-
setExcludes
public void setExcludes(java.lang.String excludes)
- Parameters:
excludes- A comma separated list of items to exclude i.e.**\/*.xml, **\/*.properties
-
getIncludes
public java.lang.String getIncludes()
- Returns:
- Returns a comma separated list of included items
-
setIncludes
public void setIncludes(java.lang.String includes)
- Parameters:
includes- A comma separated list of items to include i.e.**\/*.xml, **\/*.properties
-
setEncoding
public void setEncoding(java.lang.String encoding)
- Parameters:
encoding- The encoding to set.- Since:
- 3.0
-
getEncoding
public java.lang.String getEncoding()
- Returns:
- Returns the encoding.
- Since:
- 3.0
-
-