The method use analyzer library evaluates a Java project and produces a report of the method calls made to Java code not present within the project
This library is currently in BETA, and will proceed to GA with the following guidelines:
- BETA: Some automated testing is in place for basic functionality, greater consideration is given to incompatible API changes
- Initial GA: Majority of functionality is tested, library will follow semantic versioning guidelines from this point in regards to API compatiblity
To use this library, it must be added as a dependency reference, and then invoked within the consuming project:
This library is available in Maven Central under the GAV com.synopsys:method-analyzer-core:<version>
The primary use of the method analyzer is to find external method calls from a given set of class files, and create a report of them. This can be done via:
MethodUseAnalyzer analyzer = new MethodUseAnalyzer();
Path outputReportFile = analyzer.analyze(sourceDirectoryPath, outputDirectoryPath, projectName);
Where sourceDirectoryPath is the directory containing (either directly, or recursively) the Java *.class files to analyze, outputDirectoryPath is the directory to save the report to, and projectName is an optional human-readable label to associate with the analyzed files in generated reports. A custom name for the report file may be specified via the MethodUseAnalyzer.analyze(Path, Path, String, String) function, in place of MethodUseAnalyzer.analyze(Path, Path, String)
The output of the method use analyzer is a report file, whose formatting is documented here
Information for how to contribute to this library can be found in the contribution guidelines
If you discover a security vulnerability, contact the development team by e-mail at oss@synopsys.com
This library is distributed under the Apache 2.0 License. The only requirement for use is inclusion of the following line within your NOTICES file:
method-use-analyzer
Copyright 2020 Synopsys, Inc.
This product includes software developed at
Synopsys, Inc. (http://www.synopsys.com/).
The requirement for a copy of the license being included in distributions is fulfilled by a copy of the LICENSE file being included in constructed JAR archives