Package com.github.ferstl.maven.pomenforcers

Class PedanticPomSectionOrderEnforcer

java.lang.Object

com.github.ferstl.maven.pomenforcers.AbstractPedanticEnforcer

com.github.ferstl.maven.pomenforcers.PedanticPomSectionOrderEnforcer

All Implemented Interfaces:

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

public class PedanticPomSectionOrderEnforcer
extends AbstractPedanticEnforcer

This enforcer makes sure that the sections in your POM files are in a defined order.

 ### Example
     <rules>
       <pomSectionOrder implementation="com.github.ferstl.maven.pomenforcers.PedanticPomSectionOrderEnforcer">
         <!-- Use project coordinates before parent declaration -->
         <sectionPriorities>groupId,artifactId,version,packaging</sectionPriorities>
       </pomSectionOrder>
     </rules>
 

Since:

1.0.0

Enforcer Rule ID:

PedanticEnforcerRule.POM_SECTION_ORDER

Constructor Summary

Constructors

Constructor	Description
PedanticPomSectionOrderEnforcer()

Method Summary

Modifier and Type	Method	Description
protected void	accept(PedanticEnforcerVisitor visitor)
protected void	doEnforce(ErrorReport report)
protected PedanticEnforcerRule	getDescription()
void	setSectionPriorities(String sectionPriorities)	Comma separated list of section priorities.

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

PedanticPomSectionOrderEnforcer

public PedanticPomSectionOrderEnforcer()

Method Details

setSectionPriorities

public void setSectionPriorities(String sectionPriorities)

Comma separated list of section priorities.

Parameters:

sectionPriorities - Comma separated list of section priorities.

Since:

1.0.0

Enforcer Configuration Parameter

Default Value:

modelVersion, prerequisites, parent, groupId, artifactId, version ,packaging,name,description,url,licenses,organization ,inceptionYear,ciManagement,mailingLists,issueManagement, developers ,contributors,scm,repositories,pluginRepositories ,distributionManagement ,modules,properties,dependencyManagement ,dependencies,build,profiles,reporting,reports

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