Package org.apache.maven.enforcer.rules

Class RequireSameVersions

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.RequireSameVersions

All Implemented Interfaces:

EnforcerRuleBase

@Named("requireSameVersions")
public final class RequireSameVersions
extends AbstractStandardEnforcerRule

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<java.lang.String>	buildPlugins
private java.util.Set<java.lang.String>	dependencies
private java.util.Set<java.lang.String>	plugins
private org.apache.maven.project.MavenProject	project
private java.util.Set<java.lang.String>	reportPlugins
private boolean	sameModuleVersions
private org.apache.maven.execution.MavenSession	session
private boolean	uniqueVersions

Constructor Summary

Constructors

Constructor	Description
RequireSameVersions(org.apache.maven.project.MavenProject project, org.apache.maven.execution.MavenSession session)

Method Summary

Modifier and Type	Method	Description
(package private) void	addBuildPlugin(java.lang.String buildPlugin)
(package private) void	addDependency(java.lang.String dependency)
(package private) void	addPlugin(java.lang.String plugin)
(package private) void	addReportPlugin(java.lang.String reportPlugin)
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	collectVersionMembers(java.util.Set<org.apache.maven.artifact.Artifact> artifacts, java.util.Collection<java.lang.String> patterns, java.lang.String source, java.util.function.Function<org.apache.maven.artifact.Artifact,java.lang.String> versionResolver)
void	execute()	This is the interface into the rule.
private java.lang.String	getReportPluginVersion(org.apache.maven.artifact.Artifact artifact)
java.lang.String	toString()

Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

getCacheId, getLevel, getRuleName

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

getLog, setLog

Methods inherited from class java.lang.Object

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

Field Detail

uniqueVersions

private boolean uniqueVersions

dependencies

private java.util.Set<java.lang.String> dependencies

plugins

private java.util.Set<java.lang.String> plugins

buildPlugins

private java.util.Set<java.lang.String> buildPlugins

reportPlugins

private java.util.Set<java.lang.String> reportPlugins

sameModuleVersions

private boolean sameModuleVersions

project

private final org.apache.maven.project.MavenProject project

session

private final org.apache.maven.execution.MavenSession session

Constructor Detail

RequireSameVersions

@Inject
public RequireSameVersions(org.apache.maven.project.MavenProject project,
                           org.apache.maven.execution.MavenSession session)

Method Detail

execute

public void execute()
             throws EnforcerRuleException

Description copied from class: AbstractEnforcerRule

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag and rule level if it should stop or just log the message as a warning.

Specified by:

execute in class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

EnforcerRuleError - in order to brake a build immediately

collectVersionMembers

private java.util.Map<java.lang.String,java.util.List<java.lang.String>> collectVersionMembers(java.util.Set<org.apache.maven.artifact.Artifact> artifacts,
                                                                                                     java.util.Collection<java.lang.String> patterns,
                                                                                                     java.lang.String source,
                                                                                                     java.util.function.Function<org.apache.maven.artifact.Artifact,java.lang.String> versionResolver)

getReportPluginVersion

private java.lang.String getReportPluginVersion(org.apache.maven.artifact.Artifact artifact)

addDependency

void addDependency(java.lang.String dependency)

addPlugin

void addPlugin(java.lang.String plugin)

addBuildPlugin

void addBuildPlugin(java.lang.String buildPlugin)

addReportPlugin

void addReportPlugin(java.lang.String reportPlugin)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object