Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractEnforcerRule - Class in org.apache.maven.enforcer.rule.api
-
Entry point for custom
Enforcer Rule
. - AbstractEnforcerRule() - Constructor for class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
- AbstractEnforcerRuleConfigProvider - Class in org.apache.maven.enforcer.rule.api
-
Entry point for custom
Enforcer Rule
which provide additional rules configuration. - AbstractEnforcerRuleConfigProvider() - Constructor for class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
D
- debug(CharSequence) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
debug
level. - debug(Supplier<CharSequence>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
debug
level.
E
- EnforcerLevel - Enum in org.apache.maven.enforcer.rule.api
-
Levels steering whether a rule should fail a build or just display a warning.
- EnforcerLogger - Interface in org.apache.maven.enforcer.rule.api
-
Logger used by enforcer rule.
- EnforcerRule - Interface in org.apache.maven.enforcer.rule.api
-
Deprecated.Please see Writing a custom rule
- EnforcerRule2 - Interface in org.apache.maven.enforcer.rule.api
-
Deprecated.Please see Writing a custom rule
- EnforcerRuleBase - Interface in org.apache.maven.enforcer.rule.api
-
Base interface for old and new API.
- EnforcerRuleError - Exception in org.apache.maven.enforcer.rule.api
-
An error occurring during the execution of a rule.
- EnforcerRuleError(String) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleError
- EnforcerRuleError(String, Throwable) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleError
- EnforcerRuleError(Throwable) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleError
- 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
-
Deprecated.
source
andlongMessage
are not used - EnforcerRuleException(String) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
Construct a new
EnforcerRuleException
exception providing amessage
. - EnforcerRuleException(String, Exception) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
Construct a new
EnforcerRuleException
exception wrapping an underlyingException
and providing amessage
. - EnforcerRuleException(String, Throwable) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
Construct a new
EnforcerRuleException
exception wrapping an underlyingThrowable
and providing amessage
. - EnforcerRuleException(Throwable) - Constructor for exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
Construct a new
EnforcerRuleException
exception wrapping an underlyingThrowable
. - EnforcerRuleHelper - Interface in org.apache.maven.enforcer.rule.api
-
Deprecated.Please see Writing a custom rule
- error(CharSequence) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
error
level. - error(Supplier<CharSequence>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
error
level. - ERROR - Enum constant in enum org.apache.maven.enforcer.rule.api.EnforcerLevel
-
Fail the build.
- execute() - Method in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
This is the interface into the rule.
- execute(EnforcerRuleHelper) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule
-
Deprecated.This is the interface into the rule.
G
- getCache(String, Supplier<?>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets a cached value, or uses the provided producer to compute it.
- getCacheId() - Method in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.
- getCacheId() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule
-
Deprecated.If the rule is to be cached, this id is used as part of the key.
- getComponent(Class<T>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the component.
- getComponent(Class<T>, String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the component.
- getComponent(String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the component.
- getComponent(String, String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the component.
- getComponentList(String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the component list.
- getComponentMap(String) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the component map.
- getContainer() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the container.
- getLevel() - Method in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
Current Enforcer execution level
- getLevel() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase
-
Current Enforcer execution level
- getLog() - Method in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
-
Provide an
EnforcerLogger
instance for Rule - getLog() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper
-
Deprecated.Gets the log.
- getLongMessage() - Method in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
Deprecated.not used
- getRulesConfig() - Method in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
-
Produce rule configuration.
- getSource() - Method in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
Deprecated.not used
I
- info(CharSequence) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
info
level. - info(Supplier<CharSequence>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
info
level. - isCacheable() - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule
-
Deprecated.This method tells the enforcer if the rule results may be cached.
- isResultValid(EnforcerRule) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRule
-
Deprecated.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.
L
- longMessage - Variable in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
The long message.
O
- org.apache.maven.enforcer.rule.api - package org.apache.maven.enforcer.rule.api
S
- setLog(EnforcerLogger) - Method in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
-
Used by
EnforcerMojo
to inject logger instance - setLog(EnforcerLogger) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase
-
Used by
EnforcerMojo
to inject logger instance - source - Variable in exception org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
The source.
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.
W
- warn(CharSequence) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
warn
level. - warn(Supplier<CharSequence>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
-
Log message in
warn
level. - WARN - Enum constant in enum org.apache.maven.enforcer.rule.api.EnforcerLevel
-
Just warn.
- warnOrError(CharSequence) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
- warnOrError(Supplier<CharSequence>) - Method in interface org.apache.maven.enforcer.rule.api.EnforcerLogger
All Classes and Interfaces|All Packages|Serialized Form