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

      org.apache.maven.project.MavenProject getProject()
      Returns:
      Return the current MavenProject instance in use.

    • setProject

      PluginToolsRequest setProject(org.apache.maven.project.MavenProject project)
      Parameters:
      project - the current MavenProject
      Returns:
      This request.
      See Also:

    • getPluginDescriptor

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

    • setPluginDescriptor

      PluginToolsRequest setPluginDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
      Parameters:
      pluginDescriptor - the PluginDescriptor
      Returns:
      This request.
      See Also:

    • 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<org.apache.maven.artifact.Artifact> getDependencies()
      Returns the list of Artifact used in class path scanning for annotations
      Returns:
      the dependencies
      Since:
      3.0

    • setDependencies

      PluginToolsRequest setDependencies(Set<org.apache.maven.artifact.Artifact> dependencies)
      Parameters:
      dependencies - the dependencies
      Returns:
      This request.
      Since:
      3.0

    • getRepoSession

      org.eclipse.aether.RepositorySystemSession getRepoSession()
      Return a Repository Session
      Returns:
      a Repository Session
      Since:
      3.8.2

    • setRepoSession

      void setRepoSession(org.eclipse.aether.RepositorySystemSession repoSession)
      Set a Repository Session
      Parameters:
      repoSession - a Repository Session
      Since:
      3.8.2

    • setInternalJavadocBaseUrl

      PluginToolsRequest setInternalJavadocBaseUrl(URI baseUrl)
      Parameters:
      baseUrl - may be relative to the current site's root
      Returns:
      This request.
      Since:
      3.7.0

    • getInternalJavadocBaseUrl

      URI getInternalJavadocBaseUrl()
      Returns:
      the javadoc base url for the internal classes
      Since:
      3.7.0

    • setInternalJavadocVersion

      PluginToolsRequest setInternalJavadocVersion(String javadocVersion)
      Parameters:
      javadocVersion -
      Returns:
      This request.
      Since:
      3.7.0

    • getInternalJavadocVersion

      String getInternalJavadocVersion()
      Returns:
      the javadoc version used to create the internal javadoc site
      Since:
      3.7.0

    • setExternalJavadocBaseUrls

      PluginToolsRequest setExternalJavadocBaseUrls(List<URI> javadocLinks)
      Parameters:
      javadocLinks -
      Returns:
      This request.
      Since:
      3.7.0

    • getExternalJavadocBaseUrls

      List<URI> getExternalJavadocBaseUrls()
      Returns:
      the list of external javadoc base urls to consider
      Since:
      3.7.0

    • setSettings

      PluginToolsRequest setSettings(org.apache.maven.settings.Settings settings)
      Parameters:
      settings - the Maven settings
      Returns:
      This request.
      Since:
      3.7.0

    • getSettings

      org.apache.maven.settings.Settings getSettings()
      Returns:
      the Maven settings
      Since:
      3.7.0

    • setRequiredJavaVersion

      PluginToolsRequest setRequiredJavaVersion(String requiredJavaVersion)
      Parameters:
      requiredJavaVersion - the required Java version for this plugin or null if unknown. Must be a value according to semantics of VersionConstraint.
      Returns:
      This request.
      Since:
      3.8.0

    • getRequiredJavaVersion

      String getRequiredJavaVersion()
      Returns:
      the required Java version for this plugin or null if unknown. Is a value according to semantics of VersionConstraint.
      Since:
      3.8.0

    • setUsedMavenApiVersion

      PluginToolsRequest setUsedMavenApiVersion(String mavenApiVersion)
      Parameters:
      mavenApiVersion -
      Returns:
      his request.
      Since:
      3.8.0

    • getUsedMavenApiVersion

      String getUsedMavenApiVersion()
      Returns:
      the Maven API version being referenced or null if unknown
      Since:
      3.8.0