Field Detail

• LINE_LENGTH

  protected static final int LINE_LENGTH

  The maximum length of a display line.

  See Also:

  Constant Field Values

• LS

  protected static final String LS

  The line separator for the current OS.

• projectBuilder

  @Component
  protected ProjectBuilder projectBuilder

  Maven Project Builder component.

• artifactResolver

  @Component
  protected org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver

  Component used to resolve artifacts and download their files from remote repositories.

• remoteRepositories

  @Parameter(defaultValue="${project.remoteArtifactRepositories}",
             required=true,
             readonly=true)
  protected List<ArtifactRepository> remoteRepositories

  Remote repositories used for the project.

• localRepository

  @Parameter(defaultValue="${localRepository}",
             required=true,
             readonly=true)
  protected ArtifactRepository localRepository

  Local Repository.

• session

  @Parameter(defaultValue="${session}",
             readonly=true,
             required=true)
  protected MavenSession session

  The current build session instance. This is used for plugin manager API calls.

• output

  @Parameter(property="output")
  protected File output

  Optional parameter to write the output of this help in a given file, instead of writing to the console.
  Note: Could be a relative path.

Constructor Detail

• AbstractHelpMojo

  public AbstractHelpMojo()

Method Detail

• writeFile

  protected static void writeFile(File output,
               StringBuilder content)
                           throws IOException

  Utility method to write a content in a given file.

  Parameters:

  output - is the wanted output file.

  content - contains the content to be written to the file.

  Throws:

  IOException - if any

  See Also:

  writeFile(File, String)

• writeFile

  protected static void writeFile(File output,
               String content)
                           throws IOException

  Utility method to write a content in a given file.

  Parameters:

  output - is the wanted output file.

  content - contains the content to be written to the file.

  Throws:

  IOException - if any

• getArtifactCoordinate

  protected org.apache.maven.shared.transfer.artifact.ArtifactCoordinate getArtifactCoordinate(String artifactString,
                                                                                   String type)
                                                                                        throws MojoExecutionException

  Parses the given String into GAV artifact coordinate information, adding the given type.

  Parameters:

  artifactString - should respect the format groupId:artifactId[:version]

  type - The extension for the artifact, must not be null.

  Returns:

  the Artifact object for the artifactString parameter.

  Throws:

  MojoExecutionException - if the artifactString doesn't respect the format.

• getArtifactCoordinate

  protected org.apache.maven.shared.transfer.artifact.ArtifactCoordinate getArtifactCoordinate(String groupId,
                                                                                   String artifactId,
                                                                                   String version,
                                                                                   String type)

• getMavenProject

  protected MavenProject getMavenProject(String artifactString)
                                  throws MojoExecutionException

  Retrieves the Maven Project associated with the given artifact String, in the form of groupId:artifactId[:version]. This resolves the POM artifact at those coordinates and then builds the Maven project from it.

  Parameters:

  artifactString - Coordinates of the Maven project to get.

  Returns:

  New Maven project.

  Throws:

  MojoExecutionException - If there was an error while getting the Maven project.