Package com.github.ferstl.maven.pomenforcers

Class PedanticModuleOrderEnforcer

java.lang.Object

com.github.ferstl.maven.pomenforcers.AbstractPedanticEnforcer

com.github.ferstl.maven.pomenforcers.PedanticModuleOrderEnforcer

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2

public class PedanticModuleOrderEnforcer
extends AbstractPedanticEnforcer

This enforcer makes sure that your modules section is sorted alphabetically. Modules that should occur at a specific position in the <modules> section can be ignored.

 ### Example
     <rules>
       <moduleOrder implementation="com.github.ferstl.maven.pomenforcers.PedanticModuleOrderEnforcer">
         <!-- These modules may occur at any place in the modules section -->
         <ignoredModules>dist-deb,dist-rpm</ignoredModules>
        </moduleOrder>
     </rules>
 

Since:

1.0.0

Enforcer Rule ID:

PedanticEnforcerRule.MODULE_ORDER

Constructor Summary

Constructors

Constructor	Description
PedanticModuleOrderEnforcer()

Method Summary

Modifier and Type	Method	Description
protected void	accept(PedanticEnforcerVisitor visitor)
protected void	doEnforce(ErrorReport report)
protected PedanticEnforcerRule	getDescription()
void	setIgnoredModules(String ignoredModules)	Comma-separated list of ignored modules.

Methods inherited from class com.github.ferstl.maven.pomenforcers.AbstractPedanticEnforcer

execute, getCacheId, getHelper, getLevel, getPom, getProjectModel, isCacheable, isResultValid

Methods inherited from class java.lang.Object

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

Constructor Details

PedanticModuleOrderEnforcer

public PedanticModuleOrderEnforcer()

Method Details

setIgnoredModules

public void setIgnoredModules(String ignoredModules)

Comma-separated list of ignored modules. All modules in this list may occur at any place in the modules section.

Parameters:

ignoredModules - Comma-separated list of ignored modules.

Since:

1.0.0

Enforcer Configuration Parameter

getDescription

protected PedanticEnforcerRule getDescription()

Specified by:

getDescription in class AbstractPedanticEnforcer

accept

protected void accept(PedanticEnforcerVisitor visitor)

Specified by:

accept in class AbstractPedanticEnforcer

doEnforce

protected void doEnforce(ErrorReport report)

Specified by:

doEnforce in class AbstractPedanticEnforcer