Fork me on GitHub
Built by Maven

duplicate-finder:check

Full name:

org.basepom.maven:duplicate-finder-maven-plugin:2.0.0:check

Description:

Finds duplicate classes/resources on the classpath.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: verify.

Optional Parameters

Name Type Since Description
<bootClasspathProperty> String 1.1.1 Deprecated. System property that contains the boot class path.
User property is: duplicate-finder.bootClasspathProperty.
<checkCompileClasspath> boolean - Check resources and classes on the compile class path.
Default value is: true.
User property is: duplicate-finder.checkCompileClasspath.
<checkRuntimeClasspath> boolean - Check resources and classes on the runtime class path.
Default value is: true.
User property is: duplicate-finder.checkRuntimeClasspath.
<checkTestClasspath> boolean - Check resources and classes on the test class path.
Default value is: true.
User property is: duplicate-finder.checkTestClasspath.
<conflictingDependencies> ConflictingDependency[] - Artifacts with expected and resolved versions that are checked.
Alias is: exceptions.
<failBuildInCaseOfConflict> boolean - Fail the build if any files with the same name are found.
Default value is: false.
User property is: duplicate-finder.failBuildInCaseOfConflict.
<failBuildInCaseOfDifferentContentConflict> boolean 1.0.3 Fail the build if files with the same name but different content are detected.
Default value is: false.
User property is: duplicate-finder.failBuildInCaseOfDifferentContentConflict.
<failBuildInCaseOfEqualContentConflict> boolean 1.0.3 Fail the build if files with the same name and the same content are detected.
Default value is: false.
User property is: duplicate-finder.failBuildInCaseOfEqualContentConflict.
<ignoredClassPatterns> String[] 1.2.1 Ignored classes, which are not checked for multiple occurences.
<ignoredDependencies> MavenCoordinates[] - Dependencies that should not be checked at all.
Alias is: ignoredDependencies.
<ignoredResourcePatterns> String[] - Ignored resources, which are not checked for multiple occurences.
<includeBootClasspath> boolean 1.1.1 Deprecated. Include the boot class path in duplicate detection. This will find duplicates with the JDK internal classes (e.g. the classes in rt.jar).
Default value is: false.
User property is: duplicate-finder.includeBootClasspath.
<includePomProjects> boolean 1.2.0 Include POM projects in validation.
Default value is: false.
User property is: duplicate-finder.includePomProjects.
<preferLocal> boolean 1.1.0 Whether existing local directories with classes or existing artifacts are preferred.
Default value is: true.
User property is: duplicate-finder.preferLocal.
<printEqualFiles> boolean 1.0.6 Report files that have the same sha256 has value.
Default value is: false.
User property is: duplicate-finder.printEqualFiles.
<quiet> boolean 1.1.0 Deprecated. Quiets the plugin (report only errors).
Default value is: false.
User property is: duplicate-finder.quiet.
<resultFile> File 1.1.0 Output file for the result of the plugin.
Default value is: ${project.build.directory}/duplicate-finder-result.xml.
User property is: duplicate-finder.resultFile.
<resultFileMinClasspathCount> int 1.1.0 Minimum occurences on the class path to be listed in the result file.
Default value is: 2.
User property is: duplicate-finder.resultFileMinClasspathCount.
<skip> boolean - Skips the plugin execution.
Default value is: false.
User property is: duplicate-finder.skip.
<useDefaultClassIgnoreList> boolean 1.2.1 Use the default class ignore list.
Default value is: true.
User property is: duplicate-finder.useDefaultClassIgnoreList.
<useDefaultResourceIgnoreList> boolean - Use the default resource ignore list.
Default value is: true.
User property is: duplicate-finder.useDefaultResourceIgnoreList.
<useResultFile> boolean 1.1.0 Write result to output file.
Default value is: true.
User property is: duplicate-finder.useResultFile.

Parameter Details

<bootClasspathProperty>

Deprecated. No reason given
System property that contains the boot class path.
  • Type: java.lang.String
  • Since: 1.1.1
  • Required: No
  • User Property: duplicate-finder.bootClasspathProperty

<checkCompileClasspath>

Check resources and classes on the compile class path.
  • Type: boolean
  • Required: No
  • User Property: duplicate-finder.checkCompileClasspath
  • Default: true

<checkRuntimeClasspath>

Check resources and classes on the runtime class path.
  • Type: boolean
  • Required: No
  • User Property: duplicate-finder.checkRuntimeClasspath
  • Default: true

<checkTestClasspath>

Check resources and classes on the test class path.
  • Type: boolean
  • Required: No
  • User Property: duplicate-finder.checkTestClasspath
  • Default: true

<conflictingDependencies>

Artifacts with expected and resolved versions that are checked.
  • Type: org.basepom.mojo.duplicatefinder.ConflictingDependency[]
  • Required: No
  • Alias: exceptions

<failBuildInCaseOfConflict>

Fail the build if any files with the same name are found.
  • Type: boolean
  • Required: No
  • User Property: duplicate-finder.failBuildInCaseOfConflict
  • Default: false

<failBuildInCaseOfDifferentContentConflict>

Fail the build if files with the same name but different content are detected.
  • Type: boolean
  • Since: 1.0.3
  • Required: No
  • User Property: duplicate-finder.failBuildInCaseOfDifferentContentConflict
  • Default: false

<failBuildInCaseOfEqualContentConflict>

Fail the build if files with the same name and the same content are detected.
  • Type: boolean
  • Since: 1.0.3
  • Required: No
  • User Property: duplicate-finder.failBuildInCaseOfEqualContentConflict
  • Default: false

<ignoredClassPatterns>

Ignored classes, which are not checked for multiple occurences.
  • Type: java.lang.String[]
  • Since: 1.2.1
  • Required: No

<ignoredDependencies>

Dependencies that should not be checked at all.
  • Type: org.basepom.mojo.duplicatefinder.artifact.MavenCoordinates[]
  • Required: No
  • Alias: ignoredDependencies

<ignoredResourcePatterns>

Ignored resources, which are not checked for multiple occurences.
  • Type: java.lang.String[]
  • Required: No

<includeBootClasspath>

Deprecated. No reason given
Include the boot class path in duplicate detection. This will find duplicates with the JDK internal classes (e.g. the classes in rt.jar).
  • Type: boolean
  • Since: 1.1.1
  • Required: No
  • User Property: duplicate-finder.includeBootClasspath
  • Default: false

<includePomProjects>

Include POM projects in validation.
  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • User Property: duplicate-finder.includePomProjects
  • Default: false

<preferLocal>

Whether existing local directories with classes or existing artifacts are preferred.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: duplicate-finder.preferLocal
  • Default: true

<printEqualFiles>

Report files that have the same sha256 has value.
  • Type: boolean
  • Since: 1.0.6
  • Required: No
  • User Property: duplicate-finder.printEqualFiles
  • Default: false

<quiet>

Deprecated. No reason given
Quiets the plugin (report only errors).
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: duplicate-finder.quiet
  • Default: false

<resultFile>

Output file for the result of the plugin.
  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User Property: duplicate-finder.resultFile
  • Default: ${project.build.directory}/duplicate-finder-result.xml

<resultFileMinClasspathCount>

Minimum occurences on the class path to be listed in the result file.
  • Type: int
  • Since: 1.1.0
  • Required: No
  • User Property: duplicate-finder.resultFileMinClasspathCount
  • Default: 2

<skip>

Skips the plugin execution.
  • Type: boolean
  • Required: No
  • User Property: duplicate-finder.skip
  • Default: false

<useDefaultClassIgnoreList>

Use the default class ignore list.
  • Type: boolean
  • Since: 1.2.1
  • Required: No
  • User Property: duplicate-finder.useDefaultClassIgnoreList
  • Default: true

<useDefaultResourceIgnoreList>

Use the default resource ignore list.
  • Type: boolean
  • Required: No
  • User Property: duplicate-finder.useDefaultResourceIgnoreList
  • Default: true

<useResultFile>

Write result to output file.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: duplicate-finder.useResultFile
  • Default: true