A

AbstractBanDependencies - Class in org.apache.maven.plugins.enforcer

Abstract Rule for banning dependencies.

AbstractBanDependencies() - Constructor for class org.apache.maven.plugins.enforcer.AbstractBanDependencies

 

AbstractNonCacheableEnforcerRule - Class in org.apache.maven.plugins.enforcer

The Class AbstractNonCacheableEnforcerRule.

AbstractNonCacheableEnforcerRule() - Constructor for class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

 

AbstractPropertyEnforcerRule - Class in org.apache.maven.plugins.enforcer

Abstract enforcer rule that give a foundation to validate properties from multiple sources.

AbstractPropertyEnforcerRule() - Constructor for class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

 

AbstractRequireFiles - Class in org.apache.maven.plugins.enforcer

Contains the common code to compare an array of files against a requirement.

AbstractRequireFiles() - Constructor for class org.apache.maven.plugins.enforcer.AbstractRequireFiles

 

AbstractStandardEnforcerRule - Class in org.apache.maven.plugins.enforcer

The Class AbstractStandardEnforcerRule.

AbstractStandardEnforcerRule() - Constructor for class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

 

AbstractVersionEnforcer - Class in org.apache.maven.plugins.enforcer

Contains the common code to compare a version against a version range.

AbstractVersionEnforcer() - Constructor for class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

 

addAdditionalPlugins(Set<Plugin>, List<String>) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Add the additional plugins if they don't exist yet.

addAll(List<?>, String) - Static method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

addDependency(DependencyNode) - Method in class org.apache.maven.plugins.enforcer.utils.DependencyVersionMap

 

alignToBaseDirectory(File) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

allParamsEmpty() - Method in class org.apache.maven.plugins.enforcer.RequireOS

Helper method to check that at least one of family, name, version or arch is set.

AlwaysFail - Class in org.apache.maven.plugins.enforcer

Always fail.

AlwaysFail() - Constructor for class org.apache.maven.plugins.enforcer.AlwaysFail

 

AlwaysPass - Class in org.apache.maven.plugins.enforcer

Always pass.

AlwaysPass() - Constructor for class org.apache.maven.plugins.enforcer.AlwaysPass

 

ArtifactMatcher - Class in org.apache.maven.plugins.enforcer.utils

This class is used for matching Artifacts against a list of patterns.

ArtifactMatcher(Collection<String>, Collection<String>) - Constructor for class org.apache.maven.plugins.enforcer.utils.ArtifactMatcher

Construct class by providing patterns as strings.

ArtifactMatcher.Pattern - Class in org.apache.maven.plugins.enforcer.utils

 

ArtifactMatcher.Pattern(String) - Constructor for class org.apache.maven.plugins.enforcer.utils.ArtifactMatcher.Pattern

 

B

BanDistributionManagement - Class in org.apache.maven.plugins.enforcer

This rule will check if a pom contains a distributionManagement part.

BanDistributionManagement() - Constructor for class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

BanDuplicatePomDependencyVersions - Class in org.apache.maven.plugins.enforcer

Since Maven 3 'dependencies.dependency.(groupId:artifactId:type:classifier)' must be unique.

BanDuplicatePomDependencyVersions() - Constructor for class org.apache.maven.plugins.enforcer.BanDuplicatePomDependencyVersions

 

BannedDependencies - Class in org.apache.maven.plugins.enforcer

This rule checks that lists of dependencies are not included.

BannedDependencies() - Constructor for class org.apache.maven.plugins.enforcer.BannedDependencies

 

BannedPlugins - Class in org.apache.maven.plugins.enforcer

This rule checks that lists of plugins are not included.

BannedPlugins() - Constructor for class org.apache.maven.plugins.enforcer.BannedPlugins

 

BannedRepositories - Class in org.apache.maven.plugins.enforcer

This rule checks that this project's maven session whether have banned repositories.

BannedRepositories() - Constructor for class org.apache.maven.plugins.enforcer.BannedRepositories

 

BanTransitiveDependencies - Class in org.apache.maven.plugins.enforcer

This rule bans all transitive dependencies.

BanTransitiveDependencies() - Constructor for class org.apache.maven.plugins.enforcer.BanTransitiveDependencies

 

C

cache - Static variable in class org.apache.maven.plugins.enforcer.EnforceMojo

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

checkDependencies(Set<Artifact>, Log) - Method in class org.apache.maven.plugins.enforcer.AbstractBanDependencies

Checks the set of dependencies against the list of excludes.

checkDependencies(Set<Artifact>, Log) - Method in class org.apache.maven.plugins.enforcer.BannedDependencies

Checks the set of dependencies against the list of excludes.

checkDependencies(Set<Artifact>, Log) - Method in class org.apache.maven.plugins.enforcer.NoSnapshots

Deprecated.

Checks the set of dependencies against the list of excludes.

checkDependencies(Set<Artifact>, Log) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

Checks the set of dependencies against the list of excludes.

checkIfModelMatches(String, String, String, Model) - Method in class org.apache.maven.plugins.enforcer.utils.EnforcerRuleUtils

Make sure the model is the one I'm expecting.

combineUncheckedPlugins(Collection<String>, String) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Combines the old Collection with the new comma separated list.

compareDependency(String, Artifact) - Method in class org.apache.maven.plugins.enforcer.BannedDependencies

Compares the given pattern against the given artifact.

container - Variable in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

 

container - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

 

containsVersion(VersionRange, ArtifactVersion) - Static method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

Copied from Artifact.VersionRange.

contextualize(Context) - Method in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

 

contextualize(Context) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

createRuleMessage(int, String, EnforcerRuleException) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

D

DefaultEnforcementRuleHelper - Class in org.apache.maven.plugins.enforcer

Default implementation of the EnforcementRuleHelper interface.

DefaultEnforcementRuleHelper(MavenSession, ExpressionEvaluator, Log, PlexusContainer) - Constructor for class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

Instantiates a new default enforcement rule helper.

DependencyConvergence - Class in org.apache.maven.plugins.enforcer

 

DependencyConvergence() - Constructor for class org.apache.maven.plugins.enforcer.DependencyConvergence

 

DependencyVersionMap - Class in org.apache.maven.plugins.enforcer.utils

 

DependencyVersionMap(Log) - Constructor for class org.apache.maven.plugins.enforcer.utils.DependencyVersionMap

 

DisplayInfoMojo - Class in org.apache.maven.plugins.enforcer

This goal displays the current platform information.

DisplayInfoMojo() - Constructor for class org.apache.maven.plugins.enforcer.DisplayInfoMojo

 

displayOSInfo(Log, boolean) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Log the current OS information.

DistributionManagementCheck - Class in org.apache.maven.plugins.enforcer.utils

 

DistributionManagementCheck(MavenProject) - Constructor for class org.apache.maven.plugins.enforcer.utils.DistributionManagementCheck

 

E

endVisit(DependencyNode) - Method in class org.apache.maven.plugins.enforcer.utils.DependencyVersionMap

 

EnforceMojo - Class in org.apache.maven.plugins.enforcer

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

EnforceMojo() - Constructor for class org.apache.maven.plugins.enforcer.EnforceMojo

 

EnforcerExpressionEvaluator - Class in org.apache.maven.plugins.enforcer

The Class EnforcerExpressionEvaluator.

EnforcerExpressionEvaluator(MavenSession, PathTranslator, MavenProject, MojoExecution) - Constructor for class org.apache.maven.plugins.enforcer.EnforcerExpressionEvaluator

The Constructor.

EnforcerExpressionEvaluator(MavenSession, PathTranslator, MavenProject) - Constructor for class org.apache.maven.plugins.enforcer.EnforcerExpressionEvaluator

Deprecated.

Will be removed with 2.0

EnforcerLevel - Enum in org.apache.maven.enforcer.rule.api

Levels steering whether a rule should fail a build or just display a warning.

EnforcerRule - Interface in org.apache.maven.enforcer.rule.api

Interface to be implemented by any rules executed by the enforcer.

EnforcerRule2 - Interface in org.apache.maven.enforcer.rule.api

Interface to be implemented by any rules as of version 2.0 executed by the enforcer.

EnforcerRuleException - Exception in org.apache.maven.enforcer.rule.api

An exception occurring during the execution of a rule.

EnforcerRuleException(Object, String, String) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

Construct a new EnforcerRuleException exception providing the source and a short and long message.

EnforcerRuleException(String, Exception) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

Construct a new EnforcerRuleException exception wrapping an underlying Exception and providing a message.

EnforcerRuleException(String, Throwable) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

Construct a new EnforcerRuleException exception wrapping an underlying Throwable and providing a message.

EnforcerRuleException(String) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

Construct a new EnforcerRuleException exception providing a message.

EnforcerRuleHelper - Interface in org.apache.maven.enforcer.rule.api

This is the interface that all helpers will use.

EnforcerRuleUtils - Class in org.apache.maven.plugins.enforcer.utils

The Class EnforcerRuleUtils.

EnforcerRuleUtils(ArtifactFactory, ArtifactResolver, ArtifactRepository, List<ArtifactRepository>, MavenProject, Log) - Constructor for class org.apache.maven.plugins.enforcer.utils.EnforcerRuleUtils

Instantiates a new enforcer rule utils.

EnforcerRuleUtils(EnforcerRuleHelper) - Constructor for class org.apache.maven.plugins.enforcer.utils.EnforcerRuleUtils

Instantiates a new enforcer rule utils.

EnforcerUtils - Class in org.apache.maven.plugins.enforcer.util

 

EnforcerUtils() - Constructor for class org.apache.maven.plugins.enforcer.util.EnforcerUtils

 

enforceVersion(Log, String, String, ArtifactVersion) - Method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

Compares the specified version to see if it is allowed by the defined version range.

evaluate(String) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

EvaluateBeanshell - Class in org.apache.maven.plugins.enforcer

Rule for Maven Enforcer using Beanshell to evaluate a conditional expression.

EvaluateBeanshell() - Constructor for class org.apache.maven.plugins.enforcer.EvaluateBeanshell

 

evaluateCondition(String, Log) - Method in class org.apache.maven.plugins.enforcer.EvaluateBeanshell

Evaluate expression using Beanshell.

execute(EnforcerRuleHelper) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.AbstractBanDependencies

Execute the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

Execute the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.AlwaysFail

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.AlwaysPass

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.BanDuplicatePomDependencyVersions

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.BannedRepositories

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.BanTransitiveDependencies

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.DependencyConvergence

 

execute() - Method in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

Entry point to the mojo

execute() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

Entry point to the mojo

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.EvaluateBeanshell

 

execute() - Method in class org.apache.maven.plugins.enforcer.HelpMojo

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.ReactorModuleConvergence

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireActiveProfile

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireJavaVersion

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireMavenVersion

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireOS

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequirePrerequisite

This is the interface into the rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

Override parent to allow optional ignore of this rule.

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseVersion

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireSameVersions

 

execute(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireUpperBoundDeps

 

execute(boolean, boolean, boolean) - Method in class org.apache.maven.plugins.enforcer.utils.DistributionManagementCheck

 

F

filterArtifacts(Set<Artifact>) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

findCurrentPlugin(Plugin, MavenProject) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Given a plugin, this will retrieve the matching plugin artifact from the model.

G

getAdditionalPlugins() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

getAllPluginEntries(MavenProject) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Gets all plugin entries in build.plugins, build.pluginManagement.plugins, profile.build.plugins, reporting and profile.reporting in this project and all parents

getArch() - Method in class org.apache.maven.plugins.enforcer.RequireOS

Gets the arch.

getArtifactId() - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

getBoundPlugins(LifecycleExecutor, MavenProject, String) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Gets the plugins that are bound to the defined phases.

getCacheId() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule

If the rule is to be cached, this id is used as part of the key.

getCacheId() - Method in class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

 

getCacheId() - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the result to be different.

getCacheId() - Method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

 

getCacheId() - Method in class org.apache.maven.plugins.enforcer.DependencyConvergence

If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the result to be different.

getCacheId() - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

getCacheId() - Method in class org.apache.maven.plugins.enforcer.RequireOS

If the rule is to be cached, this id is used as part of the key.

getComponent(Class) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the component.

getComponent(String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the component.

getComponent(String, String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the component.

getComponent(Class) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getComponent(String) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getComponent(String, String) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getComponentList(String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the component list.

getComponentList(String) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getComponentMap(String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the component map.

getComponentMap(String) - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getCondition() - Method in class org.apache.maven.plugins.enforcer.EvaluateBeanshell

 

getConflictedVersionNumbers() - Method in class org.apache.maven.plugins.enforcer.utils.DependencyVersionMap

 

getContainer() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the container.

getContainer() - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getDependenciesToCheck(MavenProject) - Method in class org.apache.maven.plugins.enforcer.AbstractBanDependencies

 

getDependenciesToCheck(MavenProject) - Method in class org.apache.maven.plugins.enforcer.BannedPlugins

 

getDistributionManagement() - Method in class org.apache.maven.plugins.enforcer.utils.DistributionManagementCheck

 

getErrorMessage(Artifact) - Method in class org.apache.maven.plugins.enforcer.AbstractBanDependencies

 

getErrorMessage(Artifact) - Method in class org.apache.maven.plugins.enforcer.BannedPlugins

 

getExcludes() - Method in class org.apache.maven.plugins.enforcer.BannedDependencies

Gets the excludes.

getExcludes() - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

getFamily() - Method in class org.apache.maven.plugins.enforcer.RequireOS

Gets the family.

getFiles() - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

 

getGroupId() - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

getIncludes() - Method in class org.apache.maven.plugins.enforcer.BannedDependencies

Gets the includes.

getIncludes() - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

getLevel() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule2

Returns the level of enforcement.

getLevel() - Method in class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

Returns the level of enforcement.

getLog() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Gets the log.

getLog() - Method in class org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

 

getLongMessage() - Method in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

Gets the long message.

getMaxsize() - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

 

getMessage() - Method in class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

 

getMinsize() - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

 

getModelsRecursively(String, String, String, File) - Method in class org.apache.maven.plugins.enforcer.utils.EnforcerRuleUtils

This method loops through all the parents, getting each pom model and then its parent.

getName() - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

How the property that is being evaluated is called

getName() - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

getName() - Method in class org.apache.maven.plugins.enforcer.RequireOS

Gets the name.

getName() - Method in class org.apache.maven.plugins.enforcer.RequireProperty

 

getPhases() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

getPhaseToLifecycleMap() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Gets the phase to lifecycle map.

getProfilePlugins(MavenProject) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Finds the plugins that are listed in active profiles.

getProfiles() - Method in class org.apache.maven.plugins.enforcer.RequireActiveProfile

 

getProject() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

getPropertyName() - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

The name of the property currently being evaluated, this is used for default message pourpouses only

getPropertyName() - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

getPropertyName() - Method in class org.apache.maven.plugins.enforcer.RequireProperty

 

getRegex() - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

Get the property value to a given regular expression.

getRegexMessage() - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

Get a warning message if the regular expression is not matched.

getRules() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

getSession() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

getSource() - Method in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

Gets the source.

getSource() - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

getTranslator() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

getUnCheckedPlugins() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

getUtils() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Gets the utils.

getVariableName() - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

getVersion() - Method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

Gets the required version.

getVersion() - Method in class org.apache.maven.plugins.enforcer.RequireOS

Gets the version.

getVersion() - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

H

hasValidVersionSpecified(EnforcerRuleHelper, Plugin, List<PluginWrapper>) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Checks for valid version specified.

HelpMojo - Class in org.apache.maven.plugins.enforcer

Display help information on maven-enforcer-plugin.
Call mvn enforcer:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.apache.maven.plugins.enforcer.HelpMojo

 

I

ignoreCache - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

Use this flag to disable rule result caching.

isAll() - Method in class org.apache.maven.plugins.enforcer.RequireActiveProfile

 

isAllowed() - Method in class org.apache.maven.plugins.enforcer.RequireOS

Helper method to determine if the current OS is allowed based on the injected values for family, name, version and arch.

isAllowNulls() - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

 

isAllowRepository() - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

isAllowSite() - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

isAllowSnapshotRepository() - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

isBanLatest() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Checks if is ban latest.

isBanRelease() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Checks if is ban release.

isBanSnapshots() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Checks if is ban snapshots.

isBanTimestamps() - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Checks if is ban timestamps.

isCacheable() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule

This method tells the enforcer if the rule results may be cached.

isCacheable() - Method in class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

 

isCacheable() - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

This tells the system if the results are cacheable at all.

isCacheable() - Method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

 

isCacheable() - Method in class org.apache.maven.plugins.enforcer.DependencyConvergence

This tells the system if the results are cacheable at all.

isCacheable() - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

isCacheable() - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

This tells the system if the results are cacheable at all.

isCacheable() - Method in class org.apache.maven.plugins.enforcer.RequireOS

This method tells the enforcer if the rule results may be cached.

isDisplay() - Method in class org.apache.maven.plugins.enforcer.RequireOS

 

isFail() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

isFailFast() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

isFailWhenParentIsSnapshot() - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

isFailWhenParentIsSnapshot() - Method in class org.apache.maven.plugins.enforcer.RequireReleaseVersion

 

isIgnoreModuleDependencies() - Method in class org.apache.maven.plugins.enforcer.ReactorModuleConvergence

 

isIgnoreParent() - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

isOnlyWhenRelease() - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

isProfileActive(MavenProject, String) - Method in class org.apache.maven.plugins.enforcer.RequireActiveProfile

Checks if profile is active.

isResultValid(EnforcerRule) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Checks if cached result is valid.

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

 

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results.

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

 

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.DependencyConvergence

If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results.

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results.

isResultValid(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Checks if cached result is valid.

isSearchTransitive() - Method in class org.apache.maven.plugins.enforcer.AbstractBanDependencies

Checks if is search transitive.

isSkip() - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

isSnapshot(String) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Checks if is snapshot.

isValidFamily(String) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Helper method to check if the given family is in the following list: dos mac netware os/2 tandem unix windows win9x z/os os/400 Note: '!' is allowed at the beginning of the string and still considered valid.

L

longMessage - Variable in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

The long message.

M

match(Artifact) - Method in class org.apache.maven.plugins.enforcer.utils.ArtifactMatcher

Check if artifact matches patterns.

match(Artifact) - Method in class org.apache.maven.plugins.enforcer.utils.ArtifactMatcher.Pattern

 

mojoExecution - Variable in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

MojoExecution needed by the ExpressionEvaluator

mojoExecution - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

MojoExecution needed by the ExpressionEvaluator

N

normalizeJDKVersion(String) - Static method in class org.apache.maven.plugins.enforcer.RequireJavaVersion

Converts a jdk string from 1.5.0-11b12 to a single 3 digit version like 1.5.0-11

NoSnapshots - Class in org.apache.maven.plugins.enforcer

Deprecated.

replaced by RequireReleaseDeps

NoSnapshots() - Constructor for class org.apache.maven.plugins.enforcer.NoSnapshots

Deprecated.

 

O

org.apache.maven.enforcer.rule.api - package org.apache.maven.enforcer.rule.api

 

org.apache.maven.plugins.enforcer - package org.apache.maven.plugins.enforcer

 

org.apache.maven.plugins.enforcer.util - package org.apache.maven.plugins.enforcer.util

 

org.apache.maven.plugins.enforcer.utils - package org.apache.maven.plugins.enforcer.utils

 

P

parsePluginString(String, String) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Helper method to parse and inject a Plugin.

PluginWrapper - Class in org.apache.maven.plugins.enforcer.utils

 

PluginWrapper(Plugin, String) - Constructor for class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

PluginWrapper(ReportPlugin, String) - Constructor for class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

project - Variable in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

POM

project - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

POM

R

ReactorModuleConvergence - Class in org.apache.maven.plugins.enforcer

This rule will check if a multi module build will follow the best practices.

ReactorModuleConvergence() - Constructor for class org.apache.maven.plugins.enforcer.ReactorModuleConvergence

 

removeUncheckedPlugins(Collection<String>, Collection<Plugin>) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Remove the plugins that the user doesn't want to check.

RequireActiveProfile - Class in org.apache.maven.plugins.enforcer

This rule checks that some profiles are active.

RequireActiveProfile() - Constructor for class org.apache.maven.plugins.enforcer.RequireActiveProfile

 

RequireEnvironmentVariable - Class in org.apache.maven.plugins.enforcer

This rule checks that certain environment variable is set.

RequireEnvironmentVariable() - Constructor for class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

RequireFilesDontExist - Class in org.apache.maven.plugins.enforcer

The Class RequireFilesDontExist.

RequireFilesDontExist() - Constructor for class org.apache.maven.plugins.enforcer.RequireFilesDontExist

 

RequireFilesExist - Class in org.apache.maven.plugins.enforcer

The Class RequireFilesExist.

RequireFilesExist() - Constructor for class org.apache.maven.plugins.enforcer.RequireFilesExist

 

RequireFilesSize - Class in org.apache.maven.plugins.enforcer

Rule to validate the main artifact is within certain size constraints.

RequireFilesSize() - Constructor for class org.apache.maven.plugins.enforcer.RequireFilesSize

 

RequireJavaVersion - Class in org.apache.maven.plugins.enforcer

This rule checks that the Java version is allowed.

RequireJavaVersion() - Constructor for class org.apache.maven.plugins.enforcer.RequireJavaVersion

 

RequireMavenVersion - Class in org.apache.maven.plugins.enforcer

This rule checks that the Maven version is allowed.

RequireMavenVersion() - Constructor for class org.apache.maven.plugins.enforcer.RequireMavenVersion

 

RequireNoRepositories - Class in org.apache.maven.plugins.enforcer

This rule checks that this pom or its parents don't define a repository.

RequireNoRepositories() - Constructor for class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

RequireOS - Class in org.apache.maven.plugins.enforcer

This rule checks that the OS is allowed by combinations of family, name, version and cpu architecture.

RequireOS() - Constructor for class org.apache.maven.plugins.enforcer.RequireOS

Instantiates a new RequireOS.

RequirePluginVersions - Class in org.apache.maven.plugins.enforcer

This rule will enforce that all plugins specified in the poms have a version declared.

RequirePluginVersions() - Constructor for class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

RequirePrerequisite - Class in org.apache.maven.plugins.enforcer

 

RequirePrerequisite() - Constructor for class org.apache.maven.plugins.enforcer.RequirePrerequisite

 

RequireProperty - Class in org.apache.maven.plugins.enforcer

This rule checks that certain properties are set.

RequireProperty() - Constructor for class org.apache.maven.plugins.enforcer.RequireProperty

 

RequireReleaseDeps - Class in org.apache.maven.plugins.enforcer

This rule checks that no snapshots are included.

RequireReleaseDeps() - Constructor for class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

RequireReleaseVersion - Class in org.apache.maven.plugins.enforcer

This rule checks that the current project is not a snapshot.

RequireReleaseVersion() - Constructor for class org.apache.maven.plugins.enforcer.RequireReleaseVersion

 

RequireSameVersions - Class in org.apache.maven.plugins.enforcer

 

RequireSameVersions() - Constructor for class org.apache.maven.plugins.enforcer.RequireSameVersions

 

RequireUpperBoundDeps - Class in org.apache.maven.plugins.enforcer

Rule to enforce that the resolved dependency is also the most recent one of all transitive dependencies.

RequireUpperBoundDeps() - Constructor for class org.apache.maven.plugins.enforcer.RequireUpperBoundDeps

 

resolvePlugin(Plugin, MavenProject) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Resolve plugin.

resolvePlugins(List<Plugin>) - Method in class org.apache.maven.plugins.enforcer.utils.EnforcerRuleUtils

 

resolveReportPlugins(List<ReportPlugin>) - Method in class org.apache.maven.plugins.enforcer.utils.EnforcerRuleUtils

 

resolveValue(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

Resolves the property value

resolveValue(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

resolveValue(EnforcerRuleHelper) - Method in class org.apache.maven.plugins.enforcer.RequireProperty

 

resolveValue() - Method in class org.apache.maven.plugins.enforcer.RequireProperty

 

S

session - Variable in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

The MavenSession

session - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

The MavenSession

setAdditionalPlugins(List<String>) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

setAll(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireActiveProfile

 

setAllowedPluginRepositories(List<String>) - Method in class org.apache.maven.plugins.enforcer.BannedRepositories

 

setAllowedPluginRepositories(List<String>) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

setAllowedRepositories(List<String>) - Method in class org.apache.maven.plugins.enforcer.BannedRepositories

 

setAllowedRepositories(List<String>) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

setAllowNulls(boolean) - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

 

setAllowRepository(boolean) - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

setAllowSite(boolean) - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

setAllowSnapshotPluginRepositories(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

setAllowSnapshotRepositories(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

setAllowSnapshotRepository(boolean) - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

setArch(String) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Sets the arch.

setArtifactId(String) - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

setBanLatest(boolean) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Sets the ban latest.

setBannedPluginRepositories(List<String>) - Method in class org.apache.maven.plugins.enforcer.BannedRepositories

 

setBannedRepositories(List<String>) - Method in class org.apache.maven.plugins.enforcer.BannedRepositories

 

setBanPluginRepositories(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

setBanRelease(boolean) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Sets the ban release.

setBanRepositories(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireNoRepositories

 

setBanSnapshots(boolean) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Sets the ban snapshots.

setBanTimestamps(boolean) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Sets the ban timestamps.

setCondition(String) - Method in class org.apache.maven.plugins.enforcer.EvaluateBeanshell

 

setDisplay(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireOS

 

setDistributionManagement(DistributionManagement) - Method in class org.apache.maven.plugins.enforcer.utils.DistributionManagementCheck

 

setExcludes(List<String>) - Method in class org.apache.maven.plugins.enforcer.BannedDependencies

Specify the banned dependencies.

setExcludes(List<String>) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

setFail(boolean) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setFailFast(boolean) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setFailWhenParentIsSnapshot(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

setFailWhenParentIsSnapshot(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseVersion

 

setFamily(String) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Sets the family.

setFiles(File[]) - Method in class org.apache.maven.plugins.enforcer.AbstractRequireFiles

 

setGroupId(String) - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

setIgnoreModuleDependencies(boolean) - Method in class org.apache.maven.plugins.enforcer.ReactorModuleConvergence

 

setIgnoreParent(boolean) - Method in class org.apache.maven.plugins.enforcer.BanDistributionManagement

 

setIncludes(List<String>) - Method in class org.apache.maven.plugins.enforcer.BannedDependencies

Specify the allowed dependencies.

setIncludes(List<String>) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

setLevel(EnforcerLevel) - Method in class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

 

setMavenVersion(String) - Method in class org.apache.maven.plugins.enforcer.RequirePrerequisite

Set the mavenVersion Can either be version or a range, e.g.

setMaxsize(long) - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

 

setMessage(String) - Method in class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

 

setMinsize(long) - Method in class org.apache.maven.plugins.enforcer.RequireFilesSize

 

setName(String) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Sets the name.

setOnlyWhenRelease(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireReleaseDeps

 

setPackagings(List<String>) - Method in class org.apache.maven.plugins.enforcer.RequirePrerequisite

Only the projects with one of these packagings will be enforced to have the correct prerequisite.

setPhases(String) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

setProfiles(String) - Method in class org.apache.maven.plugins.enforcer.RequireActiveProfile

 

setProject(MavenProject) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setProperty(String) - Method in class org.apache.maven.plugins.enforcer.RequireProperty

 

setRegex(String) - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

Set the property value to a given regular expression.

setRegexMessage(String) - Method in class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

Set a warning message if the regular expression is not matched.

setRules(EnforcerRule[]) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setSearchTransitive(boolean) - Method in class org.apache.maven.plugins.enforcer.AbstractBanDependencies

Sets the search transitive.

setSession(MavenSession) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setSkip(boolean) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setSource(String) - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

setTranslator(PathTranslator) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

 

setUnCheckedPlugins(List) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

 

setUniqueVersions(boolean) - Method in class org.apache.maven.plugins.enforcer.DependencyConvergence

 

setUniqueVersions(boolean) - Method in class org.apache.maven.plugins.enforcer.RequireUpperBoundDeps

Set to true if timestamped snapshots should be used.

setUniqueVersions(boolean) - Method in class org.apache.maven.plugins.enforcer.utils.DependencyVersionMap

 

setUtils(EnforcerRuleUtils) - Method in class org.apache.maven.plugins.enforcer.RequirePluginVersions

Sets the utils.

setVariableName(String) - Method in class org.apache.maven.plugins.enforcer.RequireEnvironmentVariable

 

setVersion(String) - Method in class org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

Specify the required version.

setVersion(String) - Method in class org.apache.maven.plugins.enforcer.RequireOS

Sets the version.

setVersion(String) - Method in class org.apache.maven.plugins.enforcer.utils.PluginWrapper

 

shouldExecute(EnforcerRule) - Method in class org.apache.maven.plugins.enforcer.EnforceMojo

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

skip - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

Flag to easily skip all checks

source - Variable in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException

The source.

T

toString() - Method in class org.apache.maven.plugins.enforcer.utils.ArtifactMatcher.Pattern

 

translator - Variable in class org.apache.maven.plugins.enforcer.DisplayInfoMojo

Path Translator needed by the ExpressionEvaluator

translator - Variable in class org.apache.maven.plugins.enforcer.EnforceMojo

Path Translator needed by the ExpressionEvaluator

V

valueOf(String) - Static method in enum org.apache.maven.enforcer.rule.api.EnforcerLevel

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.maven.enforcer.rule.api.EnforcerLevel

Returns an array containing the constants of this enum type, in the order they are declared.

visit(DependencyNode) - Method in class org.apache.maven.plugins.enforcer.utils.DependencyVersionMap