Package org.apache.maven.enforcer.rules

Class AbstractStandardEnforcerRule

java.lang.Object

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

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

All Implemented Interfaces:

EnforcerRuleBase

Direct Known Subclasses:

AlwaysFail, AlwaysPass, BanDependencyManagementScope, BanDistributionManagement, BanDuplicatePomDependencyVersions, BanDynamicVersions, BannedDependencies, BannedPlugins, BannedRepositories, BanTransitiveDependencies, DependencyConvergence, EvaluateBeanshell, ReactorModuleConvergence, RequireActiveProfile, RequireEnvironmentVariable, RequireExplicitDependencyScope, RequireFileChecksum, RequireFilesDontExist, RequireFilesExist, RequireFilesSize, RequireJavaVendor, RequireJavaVersion, RequireMatchingCoordinates, RequireMavenVersion, RequireNoRepositories, RequireOS, RequirePluginVersions, RequirePrerequisite, RequireProfileIdsExist, RequireProperty, RequireReleaseDeps, RequireReleaseVersion, RequireSameVersions, RequireSnapshotVersion, RequireUpperBoundDeps

public abstract class AbstractStandardEnforcerRule
extends AbstractEnforcerRule

Abstract help rule.

Since:

3.2.0

Author:

Slawomir Jaranowski

Constructor Summary

Constructors

Constructor	Description
AbstractStandardEnforcerRule()

Method Summary

Modifier and Type	Method	Description
protected static String	formatLocation(org.apache.maven.project.MavenProject project, org.apache.maven.model.InputLocation location)	Creates a string with line/column information for problems originating directly from this POM.
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
String	getMessage()
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance
void	setMessage(String message)

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

execute, getCacheId, getLevel

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractStandardEnforcerRule

public AbstractStandardEnforcerRule()

Method Details

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

formatLocation

protected static String formatLocation(org.apache.maven.project.MavenProject project,
 org.apache.maven.model.InputLocation location)

Creates a string with line/column information for problems originating directly from this POM. Inspired by o.a.m.model.building.ModelProblemUtils.formatLocation(...).

Parameters:

project - the current project.

location - The location which should be formatted, must not be null.

Returns:

The formatted problem location or an empty string if unknown, never null.

setLog

public void setLog(EnforcerLogger log)

Used by EnforcerMojo to inject logger instance

Specified by:

setLog in interface EnforcerRuleBase

Parameters:

log - an EnforcerLogger instance

getLog

public EnforcerLogger getLog()

Provide an EnforcerLogger instance for Rule

NOTICE A logger is not available in constructors.

Returns:

an EnforcerLogger instance