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 Summary

java.lang.String	getEncoding() Gets the file encoding of the source files.
org.apache.maven.plugin.descriptor.PluginDescriptor	getPluginDescriptor() Return the PluginDescriptor currently being populated as part of the build of the current plugin project.
org.apache.maven.project.MavenProject	getProject() Return the current MavenProject instance in use.
PluginToolsRequest	setEncoding(java.lang.String encoding) Sets the file encoding of the source files.
PluginToolsRequest	setPluginDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
PluginToolsRequest	setProject(org.apache.maven.project.MavenProject project)

Method Detail

getProject

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

Return the current MavenProject instance in use.

setProject

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

See Also:

getProject()

getPluginDescriptor

public org.apache.maven.plugin.descriptor.PluginDescriptor getPluginDescriptor()

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)

See Also:

getPluginDescriptor()

getEncoding

public java.lang.String getEncoding()

Gets the file encoding of the source files.

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.

Parameters:

encoding - The file encoding of the source files, may be empty or null to use the platform's default encoding.

Returns:

This request.