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 ofPluginToolsRequest
, which is used to pass parameters to components used to extractMojoDescriptor
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<org.apache.maven.artifact.Artifact>
getDependencies()
Returns the list ofArtifact
used in class path scanning for annotationsString
getEncoding()
Gets the file encoding of the source files.List<URI>
getExternalJavadocBaseUrls()
URI
getInternalJavadocBaseUrl()
String
getInternalJavadocVersion()
org.apache.maven.plugin.descriptor.PluginDescriptor
getPluginDescriptor()
org.apache.maven.project.MavenProject
getProject()
org.eclipse.aether.RepositorySystemSession
getRepoSession()
Return a Repository SessionString
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
setPluginDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
PluginToolsRequest
setProject(org.apache.maven.project.MavenProject project)
void
setRepoSession(org.eclipse.aether.RepositorySystemSession repoSession)
Set a Repository SessionPluginToolsRequest
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)
-
-
-
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 interfacePluginToolsRequest
- 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 interfacePluginToolsRequest
- Parameters:
pluginDescriptor
- thePluginDescriptor
- Returns:
- This request.
- See Also:
PluginToolsRequest.getPluginDescriptor()
-
getProject
public org.apache.maven.project.MavenProject getProject()
- Specified by:
getProject
in interfacePluginToolsRequest
- Returns:
- Return the current
MavenProject
instance in use.
-
setProject
public PluginToolsRequest setProject(org.apache.maven.project.MavenProject project)
- Specified by:
setProject
in interfacePluginToolsRequest
- Parameters:
project
- the currentMavenProject
- Returns:
- This request.
- See Also:
PluginToolsRequest.getProject()
-
getEncoding
public String getEncoding()
Gets the file encoding of the source files.- Specified by:
getEncoding
in interfacePluginToolsRequest
- 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 interfacePluginToolsRequest
- Parameters:
encoding
- The file encoding of the source files, may be empty ornull
to use the platform's default encoding.- Returns:
- This request.
-
isSkipErrorNoDescriptorsFound
public boolean isSkipErrorNoDescriptorsFound()
- Specified by:
isSkipErrorNoDescriptorsFound
in interfacePluginToolsRequest
- 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 interfacePluginToolsRequest
- 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 ofArtifact
used in class path scanning for annotations- Specified by:
getDependencies
in interfacePluginToolsRequest
- Returns:
- the dependencies
-
setDependencies
public PluginToolsRequest setDependencies(Set<org.apache.maven.artifact.Artifact> dependencies)
- Specified by:
setDependencies
in interfacePluginToolsRequest
- 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 interfacePluginToolsRequest
- 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 interfacePluginToolsRequest
- Parameters:
repoSession
- a Repository Session
-
setInternalJavadocBaseUrl
public PluginToolsRequest setInternalJavadocBaseUrl(URI baseUrl)
- Specified by:
setInternalJavadocBaseUrl
in interfacePluginToolsRequest
- Parameters:
baseUrl
- may be relative to the current site's root- Returns:
- This request.
-
getInternalJavadocBaseUrl
public URI getInternalJavadocBaseUrl()
- Specified by:
getInternalJavadocBaseUrl
in interfacePluginToolsRequest
- Returns:
- the javadoc base url for the internal classes
-
setInternalJavadocVersion
public PluginToolsRequest setInternalJavadocVersion(String javadocVersion)
- Specified by:
setInternalJavadocVersion
in interfacePluginToolsRequest
- Returns:
- This request.
-
getInternalJavadocVersion
public String getInternalJavadocVersion()
- Specified by:
getInternalJavadocVersion
in interfacePluginToolsRequest
- Returns:
- the javadoc version used to create the internal javadoc site
-
setExternalJavadocBaseUrls
public PluginToolsRequest setExternalJavadocBaseUrls(List<URI> javadocLinks)
- Specified by:
setExternalJavadocBaseUrls
in interfacePluginToolsRequest
- Returns:
- This request.
-
getExternalJavadocBaseUrls
public List<URI> getExternalJavadocBaseUrls()
- Specified by:
getExternalJavadocBaseUrls
in interfacePluginToolsRequest
- Returns:
- the list of external javadoc base urls to consider
-
setSettings
public PluginToolsRequest setSettings(org.apache.maven.settings.Settings settings)
- Specified by:
setSettings
in interfacePluginToolsRequest
- Parameters:
settings
- the Maven settings- Returns:
- This request.
-
getSettings
public org.apache.maven.settings.Settings getSettings()
- Specified by:
getSettings
in interfacePluginToolsRequest
- Returns:
- the Maven settings
-
setRequiredJavaVersion
public PluginToolsRequest setRequiredJavaVersion(String requiredJavaVersion)
- Specified by:
setRequiredJavaVersion
in interfacePluginToolsRequest
- Parameters:
requiredJavaVersion
- the required Java version for this plugin ornull
if unknown. Must be a value according to semantics ofVersionConstraint
.- Returns:
- This request.
-
getRequiredJavaVersion
public String getRequiredJavaVersion()
- Specified by:
getRequiredJavaVersion
in interfacePluginToolsRequest
- Returns:
- the required Java version for this plugin or
null
if unknown. Is a value according to semantics ofVersionConstraint
.
-
setUsedMavenApiVersion
public PluginToolsRequest setUsedMavenApiVersion(String mavenApiVersion)
- Specified by:
setUsedMavenApiVersion
in interfacePluginToolsRequest
- Returns:
- his request.
-
getUsedMavenApiVersion
public String getUsedMavenApiVersion()
- Specified by:
getUsedMavenApiVersion
in interfacePluginToolsRequest
- Returns:
- the Maven API version being referenced or
null
if unknown
-
-