Index

B C D E F G H I J L M P Q R S T U V 
All Classes and Interfaces|All Packages

B

BEST_PRACTICES - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Best Practices

C

cache(File) - Method in class rife.bld.extension.PmdOperation
Sets the location of the cache file for incremental analysis.
cache(String) - Method in class rife.bld.extension.PmdOperation
Sets the location of the cache file for incremental analysis.
cache(Path) - Method in class rife.bld.extension.PmdOperation
Sets the location of the cache file for incremental analysis.
CODE_STYLE - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Code Style
collectFilesRecursively(boolean) - Method in class rife.bld.extension.PmdOperation
When specified, any directory mentioned with inputPaths() will only be searched for files that are direct children.
configurationErrors() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns the value of the configurationErrors record component.

D

defaultLanguageVersions() - Method in class rife.bld.extension.PmdOperation
Returns the default language versions.
defaultLanguageVersions(Collection<LanguageVersion>...) - Method in class rife.bld.extension.PmdOperation
Sets the default language version to be used for all input files.
defaultLanguageVersions(LanguageVersion...) - Method in class rife.bld.extension.PmdOperation
Sets the default language version to be used for all input files.
DESIGN - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Design
DOCUMENTATION - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Documentation

E

encoding(String) - Method in class rife.bld.extension.PmdOperation
Specifies the character set encoding of the source code files.
encoding(Charset) - Method in class rife.bld.extension.PmdOperation
Specifies the character set encoding of the source code files.
equals(Object) - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Indicates whether some other object is "equal to" this one.
ERROR_PRONE - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Error Prone
errors() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns the value of the errors record component.
excludes() - Method in class rife.bld.extension.PmdOperation
Returns the paths to exclude from the analysis.
excludes(boolean, Path...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis.
excludes(boolean, Collection<Path>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis.
excludes(Path...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis, replacing any previous entries.
excludes(Collection<Path>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis, replacing any previous entries.
excludesFiles(boolean, File...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis.
excludesFiles(boolean, Collection<File>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis.
excludesFiles(File...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis, replacing any previous entries.
excludesFiles(Collection<File>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis, replacing any previous entries.
excludesStrings(boolean, String...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis.
excludesStrings(boolean, Collection<String>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis.
excludesStrings(String...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis, replacing any previous entries.
excludesStrings(Collection<String>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to exclude from the analysis, replacing any previous entries.
execute() - Method in class rife.bld.extension.PmdOperation
Performs the PMD code analysis operation.

F

failOnError(boolean) - Method in class rife.bld.extension.PmdOperation
Sets whether the build will exit on recoverable errors.
failOnViolation(boolean) - Method in class rife.bld.extension.PmdOperation
Sets whether the build will continue on violations.
forceLanguageVersion(LanguageVersion) - Method in class rife.bld.extension.PmdOperation
Forces a language to be used for all input files, irrespective of file names.
fromProject(BaseProject) - Method in class rife.bld.extension.PmdOperation
Configures a PMD operation from a BaseProject.

G

getCategory() - Method in enum class rife.bld.extension.pmd.JavaRules
 

H

hashCode() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns a hash code value for this object.
hasNoErrors() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Checks if the analysis results indicate no errors of any type.
hasNoViolations() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Determines whether the analysis results indicate no violations of any type.

I

ignoreFile(File) - Method in class rife.bld.extension.PmdOperation
Sets the path to the file containing a list of files to ignore, one path per line.
ignoreFile(String) - Method in class rife.bld.extension.PmdOperation
Sets the path to the file containing a list of files to ignore, one path per line.
ignoreFile(Path) - Method in class rife.bld.extension.PmdOperation
Sets the path to the file containing a list of files to ignore, one path per line.
includeLineNumber(boolean) - Method in class rife.bld.extension.PmdOperation
Enables or disables line number in source file URIs.
incrementalAnalysis(boolean) - Method in class rife.bld.extension.PmdOperation
Enables or disables incremental analysis.
initConfiguration(String) - Method in class rife.bld.extension.PmdOperation
Creates a new initialized configuration.
inputPaths() - Method in class rife.bld.extension.PmdOperation
Returns paths to source files or directories containing source files to analyze.
inputPaths(boolean, File...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze.
inputPaths(boolean, String...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze.
inputPaths(boolean, Path...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze.
inputPaths(boolean, Collection<Path>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze.
inputPaths(File...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
inputPaths(String...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
inputPaths(Path...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
inputPaths(Collection<Path>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
inputPathsFiles(boolean, Collection<File>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze.
inputPathsFiles(Collection<File>...) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
inputPathsStrings(boolean, Collection<String>) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze.
inputPathsStrings(Collection<String>) - Method in class rife.bld.extension.PmdOperation
Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

J

JavaRules - Enum Class in rife.bld.extension.pmd
All built-in rules available for Java.

L

LOGGER - Static variable in class rife.bld.extension.PmdOperation
The default logger.

M

minimumPriority(RulePriority) - Method in class rife.bld.extension.PmdOperation
Sets the minimum priority threshold when loading Rules from RuleSets.
MULTITHREADING - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Multithreading

P

PERFORMANCE - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Performance
performPmdAnalysis(String, PMDConfiguration) - Method in class rife.bld.extension.PmdOperation
Performs the PMD analysis with the given config.
PmdAnalysisResults - Record Class in rife.bld.extension.pmd
Represents the results of a PMD analysis, containing various counts related to violations, errors, and rules.
PmdAnalysisResults(int, int, int, int, int, int) - Constructor for record class rife.bld.extension.pmd.PmdAnalysisResults
Creates an instance of a PmdAnalysisResults record class.
PmdOperation - Class in rife.bld.extension
Performs static code analysis with PMD.
PmdOperation() - Constructor for class rife.bld.extension.PmdOperation
 
prependAuxClasspath() - Method in class rife.bld.extension.PmdOperation
Returns the prepended classpath.
prependAuxClasspath(String...) - Method in class rife.bld.extension.PmdOperation
Prepend the specified classpath-like string to the current ClassLoader of the configuration.
processingErrors() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns the value of the processingErrors record component.

Q

QUICK_START - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Quick Start (Default RuleSet)

R

relativizeRoots() - Method in class rife.bld.extension.PmdOperation
Returns paths to shorten paths that are output in the report.
relativizeRoots(File...) - Method in class rife.bld.extension.PmdOperation
Adds several paths to shorten paths that are output in the report.
relativizeRoots(String...) - Method in class rife.bld.extension.PmdOperation
Adds several paths to shorten paths that are output in the report.
relativizeRoots(Path...) - Method in class rife.bld.extension.PmdOperation
Adds several paths to shorten paths that are output in the report.
relativizeRoots(Collection<Path>...) - Method in class rife.bld.extension.PmdOperation
Adds several paths to shorten paths that are output in the report.
relativizeRootsFiles(Collection<File>...) - Method in class rife.bld.extension.PmdOperation
Adds several paths to shorten paths that are output in the report.
relativizeRootsStrings(Collection<String>...) - Method in class rife.bld.extension.PmdOperation
Adds several paths to shorten paths that are output in the report.
reportFile() - Method in class rife.bld.extension.PmdOperation
Returns the path to the report file.
reportFile(File) - Method in class rife.bld.extension.PmdOperation
Sets the path to the report page.
reportFile(String) - Method in class rife.bld.extension.PmdOperation
Sets the path to the report page.
reportFile(Path) - Method in class rife.bld.extension.PmdOperation
Sets the path to the report page.
reportFormat(String) - Method in class rife.bld.extension.PmdOperation
Sets the output format of the analysis report.
reportProperties(Properties) - Method in class rife.bld.extension.PmdOperation
Sets the Report properties.
rife.bld.extension - package rife.bld.extension
Provides a bld extension to perform static code analysis with PMD.
rife.bld.extension.pmd - package rife.bld.extension.pmd
Defines the analysis data storage.
rulesChecked() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns the value of the rulesChecked record component.
ruleSets() - Method in class rife.bld.extension.PmdOperation
Returns the rule set paths.
ruleSets(boolean, String...) - Method in class rife.bld.extension.PmdOperation
Sets rule set paths.
ruleSets(boolean, Collection<String>...) - Method in class rife.bld.extension.PmdOperation
Sets rule set paths.
ruleSets(boolean, JavaRules...) - Method in class rife.bld.extension.PmdOperation
Sets rule set paths.
ruleSets(String...) - Method in class rife.bld.extension.PmdOperation
Sets new rule set paths, replacing any previous entries.
ruleSets(Collection<String>...) - Method in class rife.bld.extension.PmdOperation
Sets new rule set paths, replacing any previous entries.
ruleSets(JavaRules...) - Method in class rife.bld.extension.PmdOperation
Sets new rule set paths, replacing any previous entries.
ruleSetsRules(boolean, Collection<JavaRules>...) - Method in class rife.bld.extension.PmdOperation
Sets rule set paths.
ruleSetsRules(Collection<JavaRules>...) - Method in class rife.bld.extension.PmdOperation
Sets new rule set paths, replacing any previous entries.

S

SECURITY - Enum constant in enum class rife.bld.extension.pmd.JavaRules
Security
showSuppressed(boolean) - Method in class rife.bld.extension.PmdOperation
Enables or disables adding the suppressed rule violations to the report.
suppressedMarker(String) - Method in class rife.bld.extension.PmdOperation
Specifies the comment token that marks lines which should be ignored.
suppressedViolations() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns the value of the suppressedViolations record component.

T

threads(int) - Method in class rife.bld.extension.PmdOperation
Sets the number of threads to be used.
toString() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns a string representation of this record class.

U

uri(URI) - Method in class rife.bld.extension.PmdOperation
Sets the input URI to process for source code objects.

V

valueOf(String) - Static method in enum class rife.bld.extension.pmd.JavaRules
Returns the enum constant of this class with the specified name.
values() - Static method in enum class rife.bld.extension.pmd.JavaRules
Returns an array containing the constants of this enum class, in the order they are declared.
violations() - Method in record class rife.bld.extension.pmd.PmdAnalysisResults
Returns the value of the violations record component.
B C D E F G H I J L M P Q R S T U V 
All Classes and Interfaces|All Packages