Built by Maven

jdeps:jdeps-report

Note:This goal should be used as a Maven report.

Full name:

com.github.marschall:jdeps-maven-plugin:0.5.1:jdeps-report

Description:

Puts the output of the jdpes tool into a report page.

Attributes:

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

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.
filter String - Filter dependences matching the given pattern.
User property is: jdeps.filter.
filterMode String - Filter mode. Options
package
Filter dependences within the same package (default)
archive
Filter dependences within the same archive
none
No package and archive filtering. Filtering specified via the filter option still applies.

User property is: jdeps.filterMode.
include String - Restricts analysis to classes matching pattern. This option filters the list of classes to be analyzed. It can be used together with "packages" or "regex" which apply pattern to the dependencies.
User property is: jdeps.include.
jdkInternals boolean - Finds class-level dependences on JDK internal APIs. By default, it analyzes all classes and input files unless "include" option is specified. This option cannot be used with "packages", "regex" and "summary" options.

WARNING: JDK internal APIs may not be accessible in the next release.


Default value is: false.
User property is: jdeps.jdkInternals.
packages List - Restrict analysis to classes in these packages.
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.
Default value is: false.
User property is: jdeps.recursive.
regex String - Restrict analysis to packages matching pattern. ("packages" and "regex" are exclusive)
User property is: jdeps.regex.
reportOutputDirectory File - (no description)
Default value is: ${project.reporting.outputDirectory}.
summary boolean - Print dependency summary only.
Default value is: false.
User property is: jdeps.summary.
verbose boolean - Print all class level dependencies.
Default value is: false.
User property is: jdeps.verbose.
verboseLevel String - Print package-level or class-level dependencies Valid levels are: "package" and "class".
User property is: jdeps.verboseLevel.
version boolean - Version information.
Default value is: false.
User property is: jdeps.version.

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

filter:

Filter dependences matching the given pattern.
  • Type: java.lang.String
  • Required: No
  • User Property: jdeps.filter

filterMode:

Filter mode. Options
package
Filter dependences within the same package (default)
archive
Filter dependences within the same archive
none
No package and archive filtering. Filtering specified via the filter option still applies.
  • Type: java.lang.String
  • Required: No
  • User Property: jdeps.filterMode

include:

Restricts analysis to classes matching pattern. This option filters the list of classes to be analyzed. It can be used together with "packages" or "regex" which apply pattern to the dependencies.
  • Type: java.lang.String
  • Required: No
  • User Property: jdeps.include

jdkInternals:

Finds class-level dependences on JDK internal APIs. By default, it analyzes all classes and input files unless "include" option is specified. This option cannot be used with "packages", "regex" and "summary" options.

WARNING: JDK internal APIs may not be accessible in the next release.

  • Type: boolean
  • Required: No
  • User Property: jdeps.jdkInternals
  • Default: false

packages:

Restrict analysis to classes in these packages.
  • Type: java.util.List
  • 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.
  • Type: boolean
  • Required: No
  • User Property: jdeps.recursive
  • Default: false

regex:

Restrict analysis to packages matching pattern. ("packages" and "regex" are exclusive)
  • Type: java.lang.String
  • Required: No
  • User Property: jdeps.regex

reportOutputDirectory:

(no description)
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}

summary:

Print dependency summary only.
  • Type: boolean
  • Required: No
  • User Property: jdeps.summary
  • Default: false

verbose:

Print all class level dependencies.
  • Type: boolean
  • Required: No
  • User Property: jdeps.verbose
  • Default: false

verboseLevel:

Print package-level or class-level dependencies Valid levels are: "package" and "class".
  • Type: java.lang.String
  • Required: No
  • User Property: jdeps.verboseLevel

version:

Version information.
  • Type: boolean
  • Required: No
  • User Property: jdeps.version
  • Default: false