Package org.apache.maven.tools.plugin

Class DefaultPluginToolsRequest

java.lang.Object

org.apache.maven.tools.plugin.DefaultPluginToolsRequest

All Implemented Interfaces:

PluginToolsRequest

public class DefaultPluginToolsRequest
extends 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 Summary

Constructors

Constructor	Description
DefaultPluginToolsRequest(org.apache.maven.project.MavenProject project, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Method Summary

Modifier and Type	Method	Description
Set<org.apache.maven.artifact.Artifact>	getDependencies()	Returns the list of Artifact used in class path scanning for annotations
String	getEncoding()	Gets the file encoding of the source files.
List<URI>	getExternalJavadocBaseUrls()
URI	getInternalJavadocBaseUrl()
String	getInternalJavadocVersion()
org.apache.maven.artifact.repository.ArtifactRepository	getLocal()
org.apache.maven.plugin.descriptor.PluginDescriptor	getPluginDescriptor()
org.apache.maven.project.MavenProject	getProject()
List<org.apache.maven.artifact.repository.ArtifactRepository>	getRemoteRepos()
String	getRequiredJavaVersion()
org.apache.maven.settings.Settings	getSettings()
String	getUsedMavenApiVersion()
boolean	isSkipErrorNoDescriptorsFound()
PluginToolsRequest	setDependencies(Set<org.apache.maven.artifact.Artifact> dependencies)
PluginToolsRequest	setEncoding(String encoding)	Sets the file encoding of the source files.
PluginToolsRequest	setExternalJavadocBaseUrls(List<URI> javadocLinks)
PluginToolsRequest	setInternalJavadocBaseUrl(URI baseUrl)
PluginToolsRequest	setInternalJavadocVersion(String javadocVersion)
PluginToolsRequest	setLocal(org.apache.maven.artifact.repository.ArtifactRepository local)
PluginToolsRequest	setPluginDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
PluginToolsRequest	setProject(org.apache.maven.project.MavenProject project)
PluginToolsRequest	setRemoteRepos(List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos)
PluginToolsRequest	setRequiredJavaVersion(String requiredJavaVersion)
PluginToolsRequest	setSettings(org.apache.maven.settings.Settings settings)
PluginToolsRequest	setSkipErrorNoDescriptorsFound(boolean skipErrorNoDescriptorsFound)	By default an exception is throw if no mojo descriptor is found.
PluginToolsRequest	setUsedMavenApiVersion(String mavenApiVersion)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultPluginToolsRequest

public DefaultPluginToolsRequest(org.apache.maven.project.MavenProject project,
 org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Method Details

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.

setPluginDescriptor

public PluginToolsRequest setPluginDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Specified by:

setPluginDescriptor in interface PluginToolsRequest

Parameters:

pluginDescriptor - the PluginDescriptor

Returns:

This request.

See Also:

• PluginToolsRequest.getPluginDescriptor()

getProject

public org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in interface PluginToolsRequest

Returns:

Return the current MavenProject instance in use.

setProject

public PluginToolsRequest setProject(org.apache.maven.project.MavenProject project)

Specified by:

setProject in interface PluginToolsRequest

Parameters:

project - the current MavenProject

Returns:

This request.

See Also:

• PluginToolsRequest.getProject()

getEncoding

public 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(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.

isSkipErrorNoDescriptorsFound

public boolean isSkipErrorNoDescriptorsFound()

Specified by:

isSkipErrorNoDescriptorsFound in interface PluginToolsRequest

Returns:

true if no descriptor found should not cause a failure

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 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(Set<org.apache.maven.artifact.Artifact> dependencies)

Specified by:

setDependencies in interface PluginToolsRequest

Parameters:

dependencies - the dependencies

Returns:

This request.

getRemoteRepos

public List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepos()

Specified by:

getRemoteRepos in interface PluginToolsRequest

Returns:

the remote repositories

setRemoteRepos

public PluginToolsRequest setRemoteRepos(List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos)

Specified by:

setRemoteRepos in interface PluginToolsRequest

Parameters:

remoteRepos - the remote repositories

Returns:

This request.

getLocal

public org.apache.maven.artifact.repository.ArtifactRepository getLocal()

Specified by:

getLocal in interface PluginToolsRequest

Returns:

the local artifact repository

setLocal

public PluginToolsRequest setLocal(org.apache.maven.artifact.repository.ArtifactRepository local)

Specified by:

setLocal in interface PluginToolsRequest

Parameters:

local - the local repository

Returns:

This request.

setInternalJavadocBaseUrl

public PluginToolsRequest setInternalJavadocBaseUrl(URI baseUrl)

Specified by:

setInternalJavadocBaseUrl in interface PluginToolsRequest

Parameters:

baseUrl - may be relative to the current site's root

Returns:

This request.

getInternalJavadocBaseUrl

public URI getInternalJavadocBaseUrl()

Specified by:

getInternalJavadocBaseUrl in interface PluginToolsRequest

Returns:

the javadoc base url for the internal classes

setInternalJavadocVersion

public PluginToolsRequest setInternalJavadocVersion(String javadocVersion)

Specified by:

setInternalJavadocVersion in interface PluginToolsRequest

Returns:

This request.

getInternalJavadocVersion

public String getInternalJavadocVersion()

Specified by:

getInternalJavadocVersion in interface PluginToolsRequest

Returns:

the javadoc version used to create the internal javadoc site

setExternalJavadocBaseUrls

public PluginToolsRequest setExternalJavadocBaseUrls(List<URI> javadocLinks)

Specified by:

setExternalJavadocBaseUrls in interface PluginToolsRequest

Returns:

This request.

getExternalJavadocBaseUrls

public List<URI> getExternalJavadocBaseUrls()

Specified by:

getExternalJavadocBaseUrls in interface PluginToolsRequest

Returns:

the list of external javadoc base urls to consider

setSettings

public PluginToolsRequest setSettings(org.apache.maven.settings.Settings settings)

Specified by:

setSettings in interface PluginToolsRequest

Parameters:

settings - the Maven settings

Returns:

This request.

getSettings

public org.apache.maven.settings.Settings getSettings()

Specified by:

getSettings in interface PluginToolsRequest

Returns:

the Maven settings

setRequiredJavaVersion

public PluginToolsRequest setRequiredJavaVersion(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 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.

setUsedMavenApiVersion

public PluginToolsRequest setUsedMavenApiVersion(String mavenApiVersion)

Specified by:

setUsedMavenApiVersion in interface PluginToolsRequest

Returns:

his request.

getUsedMavenApiVersion

public String getUsedMavenApiVersion()

Specified by:

getUsedMavenApiVersion in interface PluginToolsRequest

Returns:

the Maven API version being referenced or null if unknown