org.apache.maven.plugins.enforcer

Class EnforceMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.enforcer.AbstractEnforceMojo

org.apache.maven.plugins.enforcer.EnforceMojo

All Implemented Interfaces:

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

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

This goal executes the defined enforcer-rules once per module.

Version:

$Id: EnforceMojo.java 1649120 2015-01-02 21:01:18Z khmarbaise $

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected static Hashtable<String,EnforcerRule>	cache This is a static variable used to persist the cached results across plugin invocations.
protected org.codehaus.plexus.PlexusContainer	container
protected boolean	ignoreCache Use this flag to disable rule result caching.

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

mojoExecution, project, session, skip, translator

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

ROLE

Constructor Summary

Constructors

Constructor and Description
EnforceMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	contextualize(org.codehaus.plexus.context.Context context)
protected String	createRuleMessage(int i, String currentRule, EnforcerRuleException e) Returns the error message displayed when failFast is set to false.
void	execute() Entry point to the mojo
EnforcerRule[]	getRules()
boolean	isFail()
boolean	isFailFast()
void	setFail(boolean theFail)
void	setFailFast(boolean theFailFast)
void	setRules(EnforcerRule[] theRules)
void	setTranslator(org.apache.maven.project.path.PathTranslator theTranslator)
protected boolean	shouldExecute(EnforcerRule rule) This method determines if a rule should execute based on the cache

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

getProject, getSession, getTranslator, isSkip, setProject, setSession, setSkip

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

Field Detail

ignoreCache

@Parameter(property="enforcer.ignoreCache",
           defaultValue="false")
protected boolean ignoreCache

Use this flag to disable rule result caching. This will cause all rules to execute on each project even if the rule indicates it can safely be cached.

cache

protected static Hashtable<String,EnforcerRule> cache

This is a static variable used to persist the cached results across plugin invocations.

container

protected org.codehaus.plexus.PlexusContainer container

Constructor Detail

EnforceMojo

public EnforceMojo()

Method Detail

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Overrides:

contextualize in class AbstractEnforceMojo

Throws:

org.codehaus.plexus.context.ContextException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Entry point to the mojo

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractEnforceMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

shouldExecute

protected boolean shouldExecute(EnforcerRule rule)

This method determines if a rule should execute based on the cache

Overrides:

shouldExecute in class AbstractEnforceMojo

Parameters:

rule - the rule to verify

Returns:

true if rule should be executed, otherwise false

isFail

public boolean isFail()

Specified by:

isFail in class AbstractEnforceMojo

Returns:

the fail

setFail

public void setFail(boolean theFail)

Parameters:

theFail - the fail to set

getRules

public EnforcerRule[] getRules()

Specified by:

getRules in class AbstractEnforceMojo

Returns:

the rules

setRules

public void setRules(EnforcerRule[] theRules)

Specified by:

setRules in class AbstractEnforceMojo

Parameters:

theRules - the rules to set

setFailFast

public void setFailFast(boolean theFailFast)

Specified by:

setFailFast in class AbstractEnforceMojo

Parameters:

theFailFast - the failFast to set

isFailFast

public boolean isFailFast()

Specified by:

isFailFast in class AbstractEnforceMojo

Returns:

the failFast

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

setTranslator

public void setTranslator(org.apache.maven.project.path.PathTranslator theTranslator)

Overrides:

setTranslator in class AbstractEnforceMojo

Parameters:

theTranslator - the translator to set