Package org.apache.maven.plugins.dependency.fromDependencies

Class BuildClasspathMojo

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.BuildClasspathMojo
All Implemented Interfaces:
Comparator<org.apache.maven.artifact.Artifact>, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="build-classpath", requiresDependencyResolution=TEST, defaultPhase=GENERATE_SOURCES, threadSafe=true) public class BuildClasspathMojo extends AbstractDependencyFilterMojo implements Comparator<org.apache.maven.artifact.Artifact>
This goal outputs a classpath string of dependencies from the local repository to a file or log.
Since:
2.0-alpha-2
Author:
ankostis

  • Constructor Details

    • BuildClasspathMojo

      public BuildClasspathMojo()

  • Method Details

    • doExecute

      protected void doExecute() throws org.apache.maven.plugin.MojoExecutionException
      Main entry into mojo. Gets the list of dependencies and iterates to create a classpath.
      Specified by:
      doExecute in class AbstractDependencyMojo
      Throws:
      org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs.
      See Also:

    • attachFile

      protected void attachFile(String cpString) throws org.apache.maven.plugin.MojoExecutionException
      Parameters:
      cpString - The classpath.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - in case of an error.

    • appendArtifactPath

      protected void appendArtifactPath(org.apache.maven.artifact.Artifact art, StringBuilder sb)
      Appends the artifact path into the specified StringBuilder.
      Parameters:
      art - Artifact
      sb - StringBuilder

    • readClasspathFile

      protected String readClasspathFile() throws IOException
      Reads the file specified by the mojo param 'outputFile' into a string. Assumes the field 'outputFile' is not null.
      Returns:
      the string contained in the classpathFile, if it exists, or null otherwise
      Throws:
      IOException - in case of an error

    • compare

      public int compare(org.apache.maven.artifact.Artifact art1, org.apache.maven.artifact.Artifact art2)
      Compares artifacts lexicographically, using pattern [group_id][artifact_id][version].
      Specified by:
      compare in interface Comparator<org.apache.maven.artifact.Artifact>
      Parameters:
      art1 - first object
      art2 - second object
      Returns:
      the value 0 if the argument string is equal to this string; a value less than 0 if this string is lexicographically less than the string argument; and a value greater than 0 if this string is lexicographically greater than the string argument.

    • getMarkedArtifactFilter

      protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()
      Description copied from class: AbstractDependencyFilterMojo
      Return an ArtifactsFilter indicating which artifacts must be filtered out.
      Specified by:
      getMarkedArtifactFilter in class AbstractDependencyFilterMojo
      Returns:
      an ArtifactsFilter indicating which artifacts must be filtered out.

    • setOutputFile

      public void setOutputFile(File outputFile)
      Parameters:
      outputFile - the outputFile to set

    • setOutputProperty

      public void setOutputProperty(String theOutputProperty)
      Parameters:
      theOutputProperty - the outputProperty to set

    • setFileSeparator

      public void setFileSeparator(String theFileSeparator)
      Parameters:
      theFileSeparator - the fileSeparator to set

    • setPathSeparator

      public void setPathSeparator(String thePathSeparator)
      Parameters:
      thePathSeparator - the pathSeparator to set

    • setPrefix

      public void setPrefix(String thePrefix)
      Parameters:
      thePrefix - the prefix to set

    • setRegenerateFile

      public void setRegenerateFile(boolean theRegenerateFile)
      Parameters:
      theRegenerateFile - the regenerateFile to set

    • isStripVersion

      public boolean isStripVersion()
      Returns:
      the stripVersion

    • setStripVersion

      public void setStripVersion(boolean theStripVersion)
      Parameters:
      theStripVersion - the stripVersion to set

    • setLocalRepoProperty

      public void setLocalRepoProperty(String localRepoProperty)
      Parameters:
      localRepoProperty - localRepoProperty