Package 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 Details

    • 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 Details

    • AbstractFromDependenciesMojo

      protected AbstractFromDependenciesMojo(org.apache.maven.execution.MavenSession session, org.sonatype.plexus.build.incremental.BuildContext buildContext, org.apache.maven.project.MavenProject project, ResolverUtil resolverUtil, org.apache.maven.project.ProjectBuilder projectBuilder, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager)

  • Method Details

    • getOutputDirectory

      public File getOutputDirectory()
      Returns:
      returns the output directory

    • 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