Package org.apache.maven.plugins.enforcer

Class BanDuplicateClasses

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractMojoHausEnforcerRule

org.apache.maven.plugins.enforcer.AbstractResolveDependencies

org.apache.maven.plugins.enforcer.BanDuplicateClasses

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2

public class BanDuplicateClasses
extends AbstractResolveDependencies

Bans duplicate classes on the classpath.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.maven.plugins.enforcer.AbstractResolveDependencies

AbstractResolveDependencies.IgnorableDependency

Field Summary

Fields

Modifier and Type	Field	Description
private static final String[]	DEFAULT_CLASSES_IGNORES	Default ignores which are needed for JDK 9, cause in JDK 9 and above the module-info.class will be duplicated in any jar file.
private List<Dependency>	dependencies	List of dependencies for which you want to ignore specific classes.
private boolean	findAllDuplicates	If false then the rule will fail at the first duplicate, if true then the rule will fail at the end.
private String[]	ignoreClasses	List of classes to ignore.
private boolean	ignoreWhenIdentical	If true do not fail the build when duplicate classes exactly match each other.
private String	message	The failure message
private List<String>	scopes	Only verify dependencies with one of these scopes

Constructor Summary

Constructors

Constructor	Description
BanDuplicateClasses()

Method Summary

Modifier and Type	Method	Description
private void	checkAndAddName(org.apache.maven.artifact.Artifact artifact, String pathToClassFile, Map<String,ClassesWithSameName> classesSeen, Set<String> duplicateClasses, Collection<AbstractResolveDependencies.IgnorableDependency> ignores)
protected void	handleArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts)

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractResolveDependencies

asRegex, execute, getCacheId, getLog, isCacheable, isResultValid, isSearchTransitive

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractMojoHausEnforcerRule

getLevel, setLevel

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CLASSES_IGNORES

private static final String[] DEFAULT_CLASSES_IGNORES

Default ignores which are needed for JDK 9, cause in JDK 9 and above the module-info.class will be duplicated in any jar file. Furthermore in use cases for multi release jars the module-info.class is also contained several times.

message

private String message

The failure message

ignoreClasses

private String[] ignoreClasses

List of classes to ignore. Wildcard at the end accepted

findAllDuplicates

private boolean findAllDuplicates

If false then the rule will fail at the first duplicate, if true then the rule will fail at the end.

dependencies

private List<Dependency> dependencies

List of dependencies for which you want to ignore specific classes.

scopes

private List<String> scopes

Only verify dependencies with one of these scopes

ignoreWhenIdentical

private boolean ignoreWhenIdentical

If true do not fail the build when duplicate classes exactly match each other. In other words, ignore duplication if the bytecode in the class files match. Default is false.

Constructor Details

BanDuplicateClasses

public BanDuplicateClasses()

Method Details

handleArtifacts

protected void handleArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts)
                        throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Specified by:

handleArtifacts in class AbstractResolveDependencies

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException

checkAndAddName

private void checkAndAddName(org.apache.maven.artifact.Artifact artifact,
 String pathToClassFile,
 Map<String,ClassesWithSameName> classesSeen,
 Set<String> duplicateClasses,
 Collection<AbstractResolveDependencies.IgnorableDependency> ignores)
                      throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException