Package org.apache.maven.enforcer.rules
Class RequireJavaVendor
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.RequireJavaVendor
- All Implemented Interfaces:
EnforcerRuleBase
@Named("requireJavaVendor")
public final class RequireJavaVendor
extends AbstractStandardEnforcerRule
This rule checks that the Java vendor is allowed.
Rule will fail is it matches any of the excludes or doesn't match any include in case it was set.
- Since:
- 3.0.0
- Author:
- Tim Sijstermans
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
The Java Vendor not changed during one Maven session, so can be cached.getLog()
void
setExcludes
(List<String> theExcludes) Specify the banned vendors.void
setIncludes
(List<String> theIncludes) Specify the allowed vendor names.void
setLog
(EnforcerLogger arg0) 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
getLevel
-
Constructor Details
-
RequireJavaVendor
public RequireJavaVendor()
-
-
Method Details
-
getCacheId
The Java Vendor not changed during one Maven session, so can be cached.- Overrides:
getCacheId
in classAbstractEnforcerRule
- Returns:
- a cache id
-
execute
- Specified by:
execute
in classAbstractEnforcerRule
- Throws:
EnforcerRuleException
-
setExcludes
Specify the banned vendors. This should be an exact match of the System Property java.vendor, which you can also see with mvn --version.
Excludes override the include rules.- Parameters:
theExcludes
- the vendor to to exclude from the include list.
-
setIncludes
Specify the allowed vendor names. This should be an exact match of the System Property java.vendor, which you can also see with mvn --version.
The rule will fail if vendor name matches any exclude, unless it also matches an include rule. Some examples are:AdoptOpenJDK
prohibits vendor name AdoptOpenJDKAmazon
prohibits vendor name Amazon
- Parameters:
theIncludes
- the list of required vendors.- See Also:
-
toString
-
setLog
- Specified by:
setLog
in interfaceEnforcerRuleBase
-
getLog
-