Package org.apache.maven.tools.plugin

Interface PluginToolsRequest

All Known Implementing Classes:
DefaultPluginToolsRequest
public interface PluginToolsRequest
Request that encapsulates all information relevant to the process of extracting MojoDescriptor instances from metadata for a certain type of mojo.
Since:
2.5
Author:
jdcasey

  • Method Details

    • getProject

      MavenProject getProject()
      Returns:
      Return the current MavenProject instance in use.

    • setProject

      PluginToolsRequest setProject​(MavenProject project)
      Parameters:
      project - the current MavenProject
      Returns:
      This request.
      See Also:
      getProject()

    • getPluginDescriptor

      PluginDescriptor getPluginDescriptor()
      Returns:
      Return the PluginDescriptor currently being populated as part of the build of the current plugin project.

    • setPluginDescriptor

      PluginToolsRequest setPluginDescriptor​(PluginDescriptor pluginDescriptor)
      Parameters:
      pluginDescriptor - the PluginDescriptor
      Returns:
      This request.
      See Also:
      getPluginDescriptor()

    • getEncoding

      String getEncoding()
      Gets the file encoding of the source files.
      Returns:
      The file encoding of the source files, never null.

    • setEncoding

      PluginToolsRequest setEncoding​(String encoding)
      Sets the file encoding of the source files.
      Parameters:
      encoding - The file encoding of the source files, may be empty or null to use the platform's default encoding.
      Returns:
      This request.

    • setSkipErrorNoDescriptorsFound

      PluginToolsRequest setSkipErrorNoDescriptorsFound​(boolean skipErrorNoDescriptorsFound)
      By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the descriptor generator mojo is bound to generate-resources phase. But for annotations, the compiled classes are needed, so skip error
      Parameters:
      skipErrorNoDescriptorsFound - true to skip errors because of not found descriptors
      Returns:
      This request.
      Since:
      3.0

    • isSkipErrorNoDescriptorsFound

      boolean isSkipErrorNoDescriptorsFound()
      Returns:
      true if no descriptor found should not cause a failure
      Since:
      3.0

    • getDependencies

      Set<Artifact> getDependencies()
      Returns the list of Artifact used in class path scanning for annotations
      Returns:
      the dependencies
      Since:
      3.0

    • setDependencies

      PluginToolsRequest setDependencies​(Set<Artifact> dependencies)
      Parameters:
      dependencies - the dependencies
      Returns:
      This request.
      Since:
      3.0

    • getRemoteRepos

      List<ArtifactRepository> getRemoteRepos()
      Returns:
      the remote repositories
      Since:
      3.0

    • setRemoteRepos

      PluginToolsRequest setRemoteRepos​(List<ArtifactRepository> remoteRepos)
      Parameters:
      remoteRepos - the remote repositories
      Returns:
      This request.
      Since:
      3.0

    • getLocal

      ArtifactRepository getLocal()
      Returns:
      the local artifact repository
      Since:
      3.0

    • setLocal

      PluginToolsRequest setLocal​(ArtifactRepository local)
      Parameters:
      local - the local repository
      Returns:
      This request.
      Since:
      3.0