org.apache.maven.plugin.dependency
Class AbstractFromDependenciesMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.dependency.AbstractDependencyMojo
          extended by org.apache.maven.plugin.dependency.AbstractDependencyFilterMojo
              extended by org.apache.maven.plugin.dependency.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.

Version:
$Id: AbstractFromDependenciesMojo.java 1085777 2011-03-26 18:13:19Z hboutemy $
Author:
Brian Fox

Field Summary
protected  boolean copyPom
          Also copy the pom of each artifact.
protected  boolean failOnMissingClassifierArtifact
          This only applies if the classifier parameter is used.
protected  File outputDirectory
          Default location used for mojo unless overridden in ArtifactItem
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.plugin.dependency.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.plugin.dependency.AbstractDependencyMojo
archiverManager, artifactCollector, artifactMetadataSource, factory, outputAbsoluteArtifactFilename, project, reactorProjects, remoteRepos, resolver, silent
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractFromDependenciesMojo()
           
 
Method Summary
 File getOutputDirectory()
           
 boolean isCopyPom()
           
 boolean isFailOnMissingClassifierArtifact()
           
 boolean isStripVersion()
           
 boolean isUseRepositoryLayout()
           
 boolean isUseSubDirectoryPerArtifact()
           
 boolean isUseSubDirectoryPerScope()
           
 boolean isUseSubDirectoryPerType()
           
 void setCopyPom(boolean copyPom)
           
 void setFailOnMissingClassifierArtifact(boolean failOnMissingClassifierArtifact)
           
 void setOutputDirectory(File theOutputDirectory)
           
 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.plugin.dependency.AbstractDependencyFilterMojo
filterMarkedDependencies, getClassifierTranslatedDependencies, getDependencySets, getMarkedArtifactFilter, getMarkersDirectory, getResolvedDependencies, isPrependGroupId, setMarkersDirectory, setPrependGroupId
 
Methods inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo
copyFile, getArchiverManager, getArtifactCollector, getArtifactMetadataSource, getFactory, getLocal, getLog, getProject, getRemoteRepos, getResolver, setArchiverManager, setArtifactCollector, setArtifactMetadataSource, setFactory, setLocal, setRemoteRepos, setResolver, unpack, unpack
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.maven.plugin.Mojo
execute
 

Field Detail

stripVersion

protected boolean stripVersion
Strip artifact version during copy

Is defined by:
expression:
${mdep.stripVersion}
default-value:
false
Is defined by:

outputDirectory

protected File outputDirectory
Default location used for mojo unless overridden in ArtifactItem

Since:
1.0
Is defined by:
expression:
${outputDirectory}
default-value:
${project.build.directory}/dependency

useRepositoryLayout

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
Is defined by:
expression:
${mdep.useRepositoryLayout}
default-value:
false

copyPom

protected boolean copyPom
Also copy the pom of each artifact.

Since:
2.0
Is defined by:
expression:
${mdep.copyPom}
default-value:
false

useSubDirectoryPerScope

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

Since:
2.2
Is defined by:
expression:
${mdep.useSubDirectoryPerScope}
default-value:
false

useSubDirectoryPerType

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

Since:
2.0-alpha-1
Is defined by:
expression:
${mdep.useSubDirectoryPerType}
default-value:
false

useSubDirectoryPerArtifact

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

Since:
2.0-alpha-1
Is defined by:
expression:
${mdep.useSubDirectoryPerArtifact}
default-value:
false

failOnMissingClassifierArtifact

protected boolean failOnMissingClassifierArtifact
This only applies if the classifier parameter is used.

Since:
2.0-alpha-2
Is defined by:
expression:
${mdep.failOnMissingClassifierArtifact}
default-value:
true
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()

setFailOnMissingClassifierArtifact

public void setFailOnMissingClassifierArtifact(boolean failOnMissingClassifierArtifact)

isStripVersion

public boolean isStripVersion()

setStripVersion

public void setStripVersion(boolean stripVersion)

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

isCopyPom

public boolean isCopyPom()
Returns:
true, if the pom of each artifact must be copied

setCopyPom

public void setCopyPom(boolean copyPom)
Parameters:
copyPom - - true if the pom of each artifact must be copied


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