Class MavenUtils

java.lang.Object
com.igormaznitsa.mvngolang.utils.MavenUtils

public final class MavenUtils
extends java.lang.Object
Auxiliary methods to work with maven entities.
Since:
2.3.0
  • Method Summary

    Modifier and Type Method Description
    static java.lang.String findProperty​(org.apache.maven.execution.MavenSession session, org.apache.maven.project.MavenProject project, java.lang.String key, java.lang.String dflt)  
    static boolean isTestPhase​(org.apache.maven.plugin.MojoExecution execution)
    Check that execution in a test mode.
    static java.lang.String makeArtifactRecord​(org.apache.maven.artifact.Artifact artifact)
    Make artifact record from a maven artifact
    static org.apache.maven.project.ProjectBuildingRequest makeResolveArtifactProjectBuildingRequest​(org.apache.maven.execution.MavenSession session, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)
    Make resolve artifact project building request.
    static org.apache.maven.artifact.Artifact parseArtifactRecord​(java.lang.String record, org.apache.maven.artifact.handler.ArtifactHandler handler)
    Parse string containing artifact record
    static java.util.List<Tuple<org.apache.maven.artifact.Artifact,​java.io.File>> scanForMvnGoArtifacts​(org.apache.maven.project.MavenProject mavenProject, boolean includeTestDependencies, org.apache.maven.plugin.AbstractMojo mojo, org.apache.maven.execution.MavenSession session, org.apache.maven.plugin.MojoExecution execution, org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver resolver, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)
    Scan project dependencies to find artifacts generated by mvn golang project.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • isTestPhase

      public static boolean isTestPhase​(@Nonnull org.apache.maven.plugin.MojoExecution execution)
      Check that execution in a test mode.
      Parameters:
      execution - maven execution object, must not be null
      Returns:
      true if a test mode is active, false otherwise
    • makeResolveArtifactProjectBuildingRequest

      @Nonnull public static org.apache.maven.project.ProjectBuildingRequest makeResolveArtifactProjectBuildingRequest​(@Nonnull org.apache.maven.execution.MavenSession session, @Nonnull @MustNotContainNull java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)
      Make resolve artifact project building request.
      Parameters:
      session - maven session, must not be null
      remoteRepositories - list of remote repositories, must not be null and can't contain null
      Returns:
      created request, must not be null
    • parseArtifactRecord

      @Nonnull public static org.apache.maven.artifact.Artifact parseArtifactRecord​(@Nonnull java.lang.String record, @Nonnull org.apache.maven.artifact.handler.ArtifactHandler handler) throws org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
      Parse string containing artifact record
      Parameters:
      record - string containing record, must not be null
      handler - artifact handler for created artifact, must not be null
      Returns:
      new created artifact from the record, must not be null
      Throws:
      org.apache.maven.artifact.versioning.InvalidVersionSpecificationException - it will be thrown if version format is wrong
      java.lang.IllegalArgumentException - it will be thrown if record can't be recognized as artifact record
    • makeArtifactRecord

      @Nonnull public static java.lang.String makeArtifactRecord​(@Nonnull org.apache.maven.artifact.Artifact artifact)
      Make artifact record from a maven artifact
      Parameters:
      artifact - artifact to be converted into string, must not be null
      Returns:
      string representation of artifact, must not be null
      See Also:
      parseArtifactRecord(java.lang.String, org.apache.maven.artifact.handler.ArtifactHandler)
    • scanForMvnGoArtifacts

      @Nonnull @MustNotContainNull public static java.util.List<Tuple<org.apache.maven.artifact.Artifact,​java.io.File>> scanForMvnGoArtifacts​(@Nonnull org.apache.maven.project.MavenProject mavenProject, boolean includeTestDependencies, @Nonnull org.apache.maven.plugin.AbstractMojo mojo, @Nonnull org.apache.maven.execution.MavenSession session, @Nonnull org.apache.maven.plugin.MojoExecution execution, @Nonnull org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver resolver, @Nonnull @MustNotContainNull java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories) throws org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException
      Scan project dependencies to find artifacts generated by mvn golang project.
      Parameters:
      mavenProject - maven project, must not be null
      includeTestDependencies - flag to process dependencies marked for test phases
      mojo - calling mojo, must not be null
      session - maven session, must not be null
      execution - maven execution, must not be null
      resolver - artifact resolver, must not be null
      remoteRepositories - list of remote repositories, must not be null
      Returns:
      list of files found in artifacts generated by mvn golang plugin
      Throws:
      org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException - exception thrown if some artifact can't be resolved
    • findProperty

      @Nullable public static java.lang.String findProperty​(@Nonnull org.apache.maven.execution.MavenSession session, @Nonnull org.apache.maven.project.MavenProject project, @Nonnull java.lang.String key, @Nullable java.lang.String dflt)