org.apache.maven.plugins.dependency.fromDependencies

Class AbstractFromDependenciesMojo

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

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CopyDependenciesMojo, UnpackDependenciesMojo

public abstract class AbstractFromDependenciesMojo
extends AbstractDependencyFilterMojo

Abstract Parent class used by mojos that get Artifact information from the project dependencies.

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failOnMissingClassifierArtifact This only applies if the classifier parameter is used.
protected File	outputDirectory Output location.
protected boolean	stripClassifier Strip artifact classifier during copy
protected boolean	stripType Strip artifact type during copy
protected boolean	stripVersion Strip artifact version during copy
protected boolean	useRepositoryLayout Place each artifact in the same directory layout as a default repository.
protected boolean	useSubDirectoryPerArtifact Place each file in a separate subdirectory.
protected boolean	useSubDirectoryPerScope Place each type of file in a separate subdirectory.
protected boolean	useSubDirectoryPerType Place each type of file in a separate subdirectory.

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

reactorProjects, session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractFromDependenciesMojo()

Method Summary

Modifier and Type	Method and Description
File	getOutputDirectory()
boolean	isFailOnMissingClassifierArtifact()
boolean	isStripType()
boolean	isStripVersion()
boolean	isUseRepositoryLayout()
boolean	isUseSubDirectoryPerArtifact()
boolean	isUseSubDirectoryPerScope()
boolean	isUseSubDirectoryPerType()
void	setFailOnMissingClassifierArtifact(boolean failOnMissingClassifierArtifact)
void	setOutputDirectory(File theOutputDirectory)
void	setStripType(boolean stripType)
void	setStripVersion(boolean stripVersion)
void	setUseRepositoryLayout(boolean useRepositoryLayout)
void	setUseSubDirectoryPerArtifact(boolean theUseSubDirectoryPerArtifact)
void	setUseSubDirectoryPerScope(boolean theUseSubDirectoryPerScope)
void	setUseSubDirectoryPerType(boolean theUseSubDirectoryPerType)

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

filterMarkedDependencies, getDependencyResolver, getDependencySets, getDependencySets, getMarkedArtifactFilter, getMarkersDirectory, getRepositoryManager, getResolvedDependencies, getResolverUtil, isPrependGroupId, setMarkersDirectory, setPrependGroupId

Methods inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

doExecute, execute, getProject, isSilent, isSkip, newResolveArtifactProjectBuildingRequest, newResolvePluginProjectBuildingRequest, setSilent, setSkip

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outputDirectory

@Parameter(property="outputDirectory",
           defaultValue="${project.build.directory}/dependency")
protected File outputDirectory

Output location.

Since:

1.0

stripVersion

@Parameter(property="mdep.stripVersion",
           defaultValue="false")
protected boolean stripVersion

Strip artifact version during copy

stripType

@Parameter(property="mdep.stripType",
           defaultValue="false")
protected boolean stripType

Strip artifact type during copy

Since:

3.4.0

stripClassifier

@Parameter(property="mdep.stripClassifier",
           defaultValue="false")
protected boolean stripClassifier

Strip artifact classifier during copy

useRepositoryLayout

@Parameter(property="mdep.useRepositoryLayout",
           defaultValue="false")
protected boolean useRepositoryLayout

Place each artifact in the same directory layout as a default repository.

example:

   /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
 

Since:

2.0-alpha-2

useSubDirectoryPerScope

@Parameter(property="mdep.useSubDirectoryPerScope",
           defaultValue="false")
protected boolean useSubDirectoryPerScope

Place each type of file in a separate subdirectory. (example /outputDirectory/runtime /outputDirectory/provided etc)

Since:

2.2

useSubDirectoryPerType

@Parameter(property="mdep.useSubDirectoryPerType",
           defaultValue="false")
protected boolean useSubDirectoryPerType

Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc)

Since:

2.0-alpha-1

useSubDirectoryPerArtifact

@Parameter(property="mdep.useSubDirectoryPerArtifact",
           defaultValue="false")
protected boolean useSubDirectoryPerArtifact

Place each file in a separate subdirectory. (example /outputDirectory/junit-3.8.1-jar)

Since:

2.0-alpha-1

failOnMissingClassifierArtifact

@Parameter(property="mdep.failOnMissingClassifierArtifact",
           defaultValue="false")
protected boolean failOnMissingClassifierArtifact

This only applies if the classifier parameter is used.

Since:

2.0-alpha-2

Constructor Detail

AbstractFromDependenciesMojo

public AbstractFromDependenciesMojo()

Method Detail

getOutputDirectory

public File getOutputDirectory()

Returns:

Returns the outputDirectory.

setOutputDirectory

public void setOutputDirectory(File theOutputDirectory)

Parameters:

theOutputDirectory - The outputDirectory to set.

isUseSubDirectoryPerArtifact

public boolean isUseSubDirectoryPerArtifact()

Returns:

Returns the useSubDirectoryPerArtifact.

setUseSubDirectoryPerArtifact

public void setUseSubDirectoryPerArtifact(boolean theUseSubDirectoryPerArtifact)

Parameters:

theUseSubDirectoryPerArtifact - The useSubDirectoryPerArtifact to set.

isUseSubDirectoryPerScope

public boolean isUseSubDirectoryPerScope()

Returns:

Returns the useSubDirectoryPerScope

setUseSubDirectoryPerScope

public void setUseSubDirectoryPerScope(boolean theUseSubDirectoryPerScope)

Parameters:

theUseSubDirectoryPerScope - The useSubDirectoryPerScope to set.

isUseSubDirectoryPerType

public boolean isUseSubDirectoryPerType()

Returns:

Returns the useSubDirectoryPerType.

setUseSubDirectoryPerType

public void setUseSubDirectoryPerType(boolean theUseSubDirectoryPerType)

Parameters:

theUseSubDirectoryPerType - The useSubDirectoryPerType to set.

isFailOnMissingClassifierArtifact

public boolean isFailOnMissingClassifierArtifact()

Returns:

failOnMissingClassifierArtifact

setFailOnMissingClassifierArtifact

public void setFailOnMissingClassifierArtifact(boolean failOnMissingClassifierArtifact)

Parameters:

failOnMissingClassifierArtifact - failOnMissingClassifierArtifact

isStripVersion

public boolean isStripVersion()

Returns:

stripVersion

setStripVersion

public void setStripVersion(boolean stripVersion)

Parameters:

stripVersion - stripVersion

isStripType

public boolean isStripType()

Returns:

stripType

setStripType

public void setStripType(boolean stripType)

Parameters:

stripType - stripType

isUseRepositoryLayout

public boolean isUseRepositoryLayout()

Returns:

true, if dependencies must be planted in a repository layout

setUseRepositoryLayout

public void setUseRepositoryLayout(boolean useRepositoryLayout)

Parameters:

useRepositoryLayout - - true if dependencies must be planted in a repository layout