org.apache.maven.plugins.enforcer

Class RecommendMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.enforcer.AbstractEnforceMojo

org.apache.maven.plugins.enforcer.RecommendMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="recommend",
      defaultPhase=VALIDATE,
      threadSafe=true)
public class RecommendMojo
extends AbstractEnforceMojo

This goal executes the defined enforcer-recommendations once per module. In contrast to EnforceMojo it will never fail the build, i.e. it will only warn.

Version:

$Id: RecommendMojo.java 1634140 2014-10-24 21:23:01Z khmarbaise $

Author:

Brian Fox, Mirko Friedenhagen

Field Summary

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractEnforceMojo

cache, container, ignoreCache, mojoExecution, project, session, skip, translator

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
RecommendMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createRuleMessage(int i, String currentRule, EnforcerRuleException e) Returns the error message displayed when failFast is set to false.
EnforcerRule[]	getRules()
boolean	isFail() Always return false, as this Mojo should never fail the build.
boolean	isFailFast() Always return false, as this Mojo should never fail the build.
void	setFailFast(boolean theFailFast)
void	setRules(EnforcerRule[] theRules)

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractEnforceMojo

contextualize, execute, getProject, getSession, getTranslator, isSkip, setProject, setSession, setSkip, setTranslator, shouldExecute

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RecommendMojo

public RecommendMojo()

Method Detail

getRules

public EnforcerRule[] getRules()

Specified by:

getRules in class AbstractEnforceMojo

Returns:

the recommendedRules

setRules

public void setRules(EnforcerRule[] theRules)

Specified by:

setRules in class AbstractEnforceMojo

Parameters:

theRules - the recommendedRules to set

setFailFast

public void setFailFast(boolean theFailFast)

Specified by:

setFailFast in class AbstractEnforceMojo

Parameters:

theFailFast - the failFast to set

isFail

public boolean isFail()

Always return false, as this Mojo should never fail the build.

Specified by:

isFail in class AbstractEnforceMojo

Returns:

false

isFailFast

public boolean isFailFast()

Always return false, as this Mojo should never fail the build.

Specified by:

isFailFast in class AbstractEnforceMojo

Returns:

false

createRuleMessage

protected String createRuleMessage(int i,
                       String currentRule,
                       EnforcerRuleException e)

Description copied from class: AbstractEnforceMojo

Returns the error message displayed when failFast is set to false.

Specified by:

createRuleMessage in class AbstractEnforceMojo

Parameters:

i - index

currentRule - name of the current rule.

e - rule exception

Returns:

rule message