Apache Maven JDeps Plugin – jdeps:jdkinternals

jdeps:jdkinternals

Full name:

org.apache.maven.plugins:maven-jdeps-plugin:3.1.1:jdkinternals

Description:

Check if main classes depend on internal JDK classes

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: compile.
Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name	Type	Since	Description
`<apiOnly>`	`boolean`	`-`	Restrict analysis to APIs i.e. dependences from the signature of public and protected members of public classes including field type, method parameter types, returned type, checked exception types etc Default value is: `false`. User property is: `jdeps.apionly`.
`<dependenciesToAnalyzeExcludes>`	`List`	`-`	Subset of `AbstractJDepsMojo.dependenciesToAnalyzeIncludes` which should be not analyzed. Specify as `groupId:artifactId`, allowing ant-pattern. E.g. <dependenciesToAnalyzeExcludes> <exclude>org.foo.:</exclude> <exclude>com.foo.bar:*</exclude> <exclude>dot.foo.bar:utilities</exclude> </dependenciesToAnalyzeExcludes>
`<dependenciesToAnalyzeIncludes>`	`List`	`-`	Additional dependencies which should be analyzed besides the classes. Specify as `groupId:artifactId`, allowing ant-pattern. E.g. <dependenciesToAnalyzeIncludes> <include>:</include> <include>org.foo.:</include> <include>com.foo.bar:*</include> <include>dot.foo.bar:utilities</include> </dependenciesToAnalyzeIncludes>
`<dotOutput>`	`File`	`-`	Destination directory for DOT file output User property is: `jdeps.dotOutput`.
`<failOnWarning>`	`boolean`	`-`	Indicates whether the build will continue even if there are jdeps warnings. Default value is: `true`. User property is: `jdeps.failOnWarning`.
`<include>`	`String`	`-`	Restrict analysis to classes matching pattern. This option filters the list of classes to be analyzed. It can be used together with `-p` and `-e` which apply pattern to the dependences User property is: `jdeps.include`.
`<module>`	`String`	`JDK 1.9.0`	Specifies the root module for analysis. User property is: `jdeps.module`.
`<multiRelease>`	`String`	`3.1.1`	Specifies the version when processing multi-release JAR files version should be an integer >=9 or base.
`<packages>`	`List`	`3.1.1.`	Finds dependences matching the specified package name.
`<profile>`	`boolean`	`-`	Show profile or the file containing a package Default value is: `false`. User property is: `jdeps.profile`.
`<recursive>`	`boolean`	`-`	Recursively traverse all dependencies. The `-R` option implies `-filter:none`. If `-p`, `-e`, `-f` option is specified, only the matching dependences are analyzed. Default value is: `false`. User property is: `jdeps.recursive`.
`<verbose>`	`String`	`-`	package Print package-level dependencies excluding dependencies within the same archive class Print class-level dependencies excluding dependencies within the same archive <empty> Print all class level dependencies. Equivalent to -verbose:class -filter:none. User property is: `jdeps.verbose`.

Parameter Details

<apiOnly>

Restrict analysis to APIs i.e. dependences from the signature of public and protected members of public classes including field type, method parameter types, returned type, checked exception types etc

Type: boolean
Required: No
User Property: jdeps.apionly
Default: false

<dependenciesToAnalyzeExcludes>

Subset of AbstractJDepsMojo.dependenciesToAnalyzeIncludes which should be not analyzed. Specify as groupId:artifactId, allowing ant-pattern. E.g.

  <dependenciesToAnalyzeExcludes>
    <exclude>org.foo.*:*</exclude>
    <exclude>com.foo.bar:*</exclude>
    <exclude>dot.foo.bar:utilities</exclude>
  </dependenciesToAnalyzeExcludes>

Type: java.util.List
Required: No

<dependenciesToAnalyzeIncludes>

Additional dependencies which should be analyzed besides the classes. Specify as groupId:artifactId, allowing ant-pattern. E.g.

  <dependenciesToAnalyzeIncludes>
    <include>*:*</include>
    <include>org.foo.*:*</include>
    <include>com.foo.bar:*</include>
    <include>dot.foo.bar:utilities</include>
  </dependenciesToAnalyzeIncludes>

Type: java.util.List
Required: No

<dotOutput>

Destination directory for DOT file output

Type: java.io.File
Required: No
User Property: jdeps.dotOutput

<failOnWarning>

Indicates whether the build will continue even if there are jdeps warnings.

Type: boolean
Required: No
User Property: jdeps.failOnWarning
Default: true

<include>

Restrict analysis to classes matching pattern. This option filters the list of classes to be analyzed. It can be used together with -p and -e which apply pattern to the dependences

Type: java.lang.String
Required: No
User Property: jdeps.include

<module>

Specifies the root module for analysis.

Type: java.lang.String
Since: JDK 1.9.0
Required: No
User Property: jdeps.module

<multiRelease>

Specifies the version when processing multi-release JAR files version should be an integer >=9 or base.

Type: java.lang.String
Since: 3.1.1
Required: No

<packages>

Finds dependences matching the specified package name.

Type: java.util.List
Since: 3.1.1.
Required: No

<profile>

Show profile or the file containing a package

Type: boolean
Required: No
User Property: jdeps.profile
Default: false

<recursive>

Recursively traverse all dependencies. The -R option implies -filter:none. If -p, -e, -f option is specified, only the matching dependences are analyzed.

Type: boolean
Required: No
User Property: jdeps.recursive
Default: false

<verbose>

package: Print package-level dependencies excluding dependencies within the same archive
class: Print class-level dependencies excluding dependencies within the same archive
<empty>: Print all class level dependencies. Equivalent to -verbose:class -filter:none.

Type: java.lang.String
Required: No
User Property: jdeps.verbose