Class DefaultPluginToolsRequest

  • All Implemented Interfaces:
    PluginToolsRequest

    public class DefaultPluginToolsRequest
    extends java.lang.Object
    implements PluginToolsRequest
    Default implementation of PluginToolsRequest, which is used to pass parameters to components used to extract MojoDescriptor instances from different types of metadata for a given plugin.
    Since:
    2.5
    Author:
    jdcasey
    • Constructor Detail

      • DefaultPluginToolsRequest

        public DefaultPluginToolsRequest​(org.apache.maven.project.MavenProject project,
                                         org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
    • Method Detail

      • getPluginDescriptor

        public org.apache.maven.plugin.descriptor.PluginDescriptor getPluginDescriptor()
        Specified by:
        getPluginDescriptor in interface PluginToolsRequest
        Returns:
        Return the PluginDescriptor currently being populated as part of the build of the current plugin project.
      • getProject

        public org.apache.maven.project.MavenProject getProject()
        Specified by:
        getProject in interface PluginToolsRequest
        Returns:
        Return the current MavenProject instance in use.
      • getEncoding

        public java.lang.String getEncoding()
        Gets the file encoding of the source files.
        Specified by:
        getEncoding in interface PluginToolsRequest
        Returns:
        The file encoding of the source files, never null.
      • setEncoding

        public PluginToolsRequest setEncoding​(java.lang.String encoding)
        Sets the file encoding of the source files.
        Specified by:
        setEncoding in interface PluginToolsRequest
        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

        public 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
        Specified by:
        setSkipErrorNoDescriptorsFound in interface PluginToolsRequest
        Parameters:
        skipErrorNoDescriptorsFound - true to skip errors because of not found descriptors
        Returns:
        This request.
      • getDependencies

        public java.util.Set<org.apache.maven.artifact.Artifact> getDependencies()
        Description copied from interface: PluginToolsRequest
        Returns the list of Artifact used in class path scanning for annotations
        Specified by:
        getDependencies in interface PluginToolsRequest
        Returns:
        the dependencies
      • setDependencies

        public PluginToolsRequest setDependencies​(java.util.Set<org.apache.maven.artifact.Artifact> dependencies)
        Specified by:
        setDependencies in interface PluginToolsRequest
        Parameters:
        dependencies - the dependencies
        Returns:
        This request.
      • getRepoSession

        public org.eclipse.aether.RepositorySystemSession getRepoSession()
        Description copied from interface: PluginToolsRequest
        Return a Repository Session
        Specified by:
        getRepoSession in interface PluginToolsRequest
        Returns:
        a Repository Session
      • setRepoSession

        public void setRepoSession​(org.eclipse.aether.RepositorySystemSession repoSession)
        Description copied from interface: PluginToolsRequest
        Set a Repository Session
        Specified by:
        setRepoSession in interface PluginToolsRequest
        Parameters:
        repoSession - a Repository Session
      • getInternalJavadocVersion

        public java.lang.String getInternalJavadocVersion()
        Specified by:
        getInternalJavadocVersion in interface PluginToolsRequest
        Returns:
        the javadoc version used to create the internal javadoc site
      • getExternalJavadocBaseUrls

        public java.util.List<java.net.URI> getExternalJavadocBaseUrls()
        Specified by:
        getExternalJavadocBaseUrls in interface PluginToolsRequest
        Returns:
        the list of external javadoc base urls to consider
      • getSettings

        public org.apache.maven.settings.Settings getSettings()
        Specified by:
        getSettings in interface PluginToolsRequest
        Returns:
        the Maven settings
      • setRequiredJavaVersion

        public PluginToolsRequest setRequiredJavaVersion​(java.lang.String requiredJavaVersion)
        Specified by:
        setRequiredJavaVersion in interface PluginToolsRequest
        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.
      • getRequiredJavaVersion

        public java.lang.String getRequiredJavaVersion()
        Specified by:
        getRequiredJavaVersion in interface PluginToolsRequest
        Returns:
        the required Java version for this plugin or null if unknown. Is a value according to semantics of VersionConstraint.
      • getUsedMavenApiVersion

        public java.lang.String getUsedMavenApiVersion()
        Specified by:
        getUsedMavenApiVersion in interface PluginToolsRequest
        Returns:
        the Maven API version being referenced or null if unknown