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 and Description
DefaultPluginToolsRequest(org.apache.maven.project.MavenProject project, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

Method Summary

Methods

Modifier and Type	Method and Description
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(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)

Methods inherited from class java.lang.Object

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

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()

Return the PluginDescriptor currently being populated as part of the build of the current plugin project.

Specified by:

getPluginDescriptor in interface PluginToolsRequest

setPluginDescriptor

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

Specified by:

setPluginDescriptor in interface PluginToolsRequest

See Also:

PluginToolsRequest.getPluginDescriptor()

getProject

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

Return the current MavenProject instance in use.

Specified by:

getProject in interface PluginToolsRequest

setProject

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

Specified by:

setProject in interface PluginToolsRequest

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.