net.kemitix.quality.api

Interface PluginGoal

All Known Implementing Classes:

AbstractPluginGoal

public interface PluginGoal

A Plugin and a Goal of that plugin.

Author:

Paul Campbell (pcampbell@kemitix.net)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PluginGoal.LifecyclePhase Maven Lifecycles to run PluginGoals in.

Method Summary

Modifier and Type	Method and Description
void	configuration(PluginGoalConfiguration configuration) Configure the Plugin Goal.
default String	configValue(String elementName) Extract the value of a configuration element by name.
org.codehaus.plexus.util.xml.Xpp3Dom	getConfiguration() Gets the Configuration of the plugin.
List<String>	getGoals() Get the Goals for the Plugin.
String	getName() Returns the name of the plugin-goal.
org.apache.maven.model.Plugin	getPlugin() Get the Plugin.
default Integer	getWeight() Defines the weight of the plugin goal.
void	groupArtifactVersion(String groupId, String artifactId, String version) Set the maven coordinates for the plugin.
default boolean	matches(PluginGoal.LifecyclePhase lifecyclePhase) Defines the maven lifecycle phase to run the plugin in.
default void	onComplete(String goal) Hook called just after the plugin is executed, whether there is any error or not.
default void	onError(String goal, org.apache.maven.plugin.MojoExecutionException e) Hook called if there is an error when the plugin is executed.
default void	onExecute(String goal) Hook called just before the plugin is executed.
default void	onSuccess(String goal) Hook called just after the plugin is executed without throwing any exceptions.

Method Detail

getPlugin

org.apache.maven.model.Plugin getPlugin()

Get the Plugin.

Returns:

the Plugin

getGoals

List<String> getGoals()

Get the Goals for the Plugin.

Returns:

the goal names

groupArtifactVersion

void groupArtifactVersion(String groupId,
                          String artifactId,
                          String version)

Set the maven coordinates for the plugin.

Parameters:

groupId - The groupId

artifactId - The artifactId

version - The version

configuration

void configuration(PluginGoalConfiguration configuration)

Configure the Plugin Goal.

Parameters:

configuration - The configuration

getConfiguration

org.codehaus.plexus.util.xml.Xpp3Dom getConfiguration()

Gets the Configuration of the plugin.

Returns:

the Xpp3Dom configuration

configValue

default String configValue(String elementName)

Extract the value of a configuration element by name.

Parameters:

elementName - the name of the element

Returns:

the value of the element

onExecute

default void onExecute(String goal)

Hook called just before the plugin is executed.

This default implementation does nothing.

Parameters:

goal - The goal

onSuccess

default void onSuccess(String goal)

Hook called just after the plugin is executed without throwing any exceptions.

This default implementation does nothing.

Parameters:

goal - The goal

onError

default void onError(String goal,
                     org.apache.maven.plugin.MojoExecutionException e)

Hook called if there is an error when the plugin is executed.

This default implementation does nothing.

Parameters:

goal - The goal

e - The exception that was thrown

onComplete

default void onComplete(String goal)

Hook called just after the plugin is executed, whether there is any error or not.

This default implementation does nothing.

Parameters:

goal - The goal

getName

String getName()

Returns the name of the plugin-goal.

e.g. This is the name used when a plugin needs to be disabled.

Returns:

the name of the plugin goal

getWeight

default Integer getWeight()

Defines the weight of the plugin goal.

Lighter (lower numberically) plugin goals are executed first.

Returns:

the weight of the plugin goal

matches

default boolean matches(PluginGoal.LifecyclePhase lifecyclePhase)

Defines the maven lifecycle phase to run the plugin in.

Parameters:

lifecyclePhase - the phase

Returns:

true if the phase is the same