Index
All Classes and Interfaces|All Packages
B
- branchMatchingXpath(String) - Method in class rife.bld.extension.CheckstyleOperation
-
Shows Abstract Syntax Tree (AST) branches that match the given XPath query.
C
- CheckstyleOperation - Class in rife.bld.extension
-
Static code analysis operation using Checkstyle.
- CheckstyleOperation() - Constructor for class rife.bld.extension.CheckstyleOperation
- configurationFile(File) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies the location of the Checkstyle configuration file.
- configurationFile(String) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies the location of the Checkstyle configuration file.
- configurationFile(Path) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies the location of the Checkstyle configuration file.
D
- debug(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Enables or disables debug logging for the Checkstyle utility.
E
- exclude() - Method in class rife.bld.extension.CheckstyleOperation
-
Retrieves the list of files and directories excluded from analysis.
- exclude(File...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directories or files to exclude from Checkstyle analysis.
- exclude(String...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directories or files to exclude from Checkstyle analysis.
- exclude(Path...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directories or files to exclude from Checkstyle analysis.
- exclude(Collection<File>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directories or files to exclude from Checkstyle analysis.
- excludePaths(Collection<Path>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directories or files to exclude from Checkstyle analysis.
- excludeRegex() - Method in class rife.bld.extension.CheckstyleOperation
-
Retrieves the list of regex patterns excluded from analysis.
- excludeRegex(String...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directory or file patterns to exclude from Checkstyle analysis.
- excludeRegex(Collection<String>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directory or file patterns to exclude from Checkstyle analysis.
- excludeStrings(Collection<String>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies directories or files to exclude from Checkstyle analysis.
- executeConstructProcessCommandList() - Method in class rife.bld.extension.CheckstyleOperation
-
Part of the
AbstractProcessOperation.execute()operation, constructs the command list to use for building the process. - executeIgnoredModules(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Allows ignored modules to be executed.
F
- format(OutputFormat) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies the output format for Checkstyle results.
- fromProject(BaseProject) - Method in class rife.bld.extension.CheckstyleOperation
-
Configures the operation from a
BaseProject. - fromString(String) - Static method in enum class rife.bld.extension.checkstyle.OutputFormat
-
Parses a string into an
OutputFormat.
G
- generateChecksAndFileSuppression(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Generates suppression XML files for checks and files.
- generateXpathSuppression(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Generates XPath suppression XML.
J
- javadocTree(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Prints the Javadoc parse tree.
O
- options() - Method in class rife.bld.extension.CheckstyleOperation
-
Returns the mutable map of command line options.
- OutputFormat - Enum Class in rife.bld.extension.checkstyle
-
The Checkstyle output format for XML, SARIF and default (plain) logger.
- outputPath(File) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the output file for Checkstyle results.
- outputPath(String) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the output file for Checkstyle results.
- outputPath(Path) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the output file for Checkstyle results.
P
- PLAIN - Enum constant in enum class rife.bld.extension.checkstyle.OutputFormat
-
Default (plain) output format.
- propertiesFile(File) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the properties file for Checkstyle.
- propertiesFile(String) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the properties file for Checkstyle.
- propertiesFile(Path) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the properties file for Checkstyle.
R
- rife.bld.extension - package rife.bld.extension
-
Provides a bld extension to check source code with Checkstyle.
- rife.bld.extension.checkstyle - package rife.bld.extension.checkstyle
-
Defines the Checkstyle formats.
S
- SARIF - Enum constant in enum class rife.bld.extension.checkstyle.OutputFormat
-
Static Analysis Results Interchange Format (SARIF) output format.
- sourceDir() - Method in class rife.bld.extension.CheckstyleOperation
-
Returns the set of source directories to analyze.
- sourceDir(File...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies source directories to analyze.
- sourceDir(String...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies source directories to analyze.
- sourceDir(Path...) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies source directories to analyze.
- sourceDir(Collection<File>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies source directories to analyze.
- sourceDirPaths(Collection<Path>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies source directories to analyze.
- sourceDirStrings(Collection<String>) - Method in class rife.bld.extension.CheckstyleOperation
-
Specifies source directories to analyze.
- suppressionLineColumnNumber(int, int) - Method in class rife.bld.extension.CheckstyleOperation
-
Prints XPath suppressions for a specific line and column.
T
- tabWidth(int) - Method in class rife.bld.extension.CheckstyleOperation
-
Sets the tab width for column reporting.
- toString() - Method in enum class rife.bld.extension.checkstyle.OutputFormat
- tree(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Prints the Abstract Syntax Tree without comments.
- treeWithComments(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Prints the Abstract Syntax Tree with comment nodes included.
- treeWithJavadoc(boolean) - Method in class rife.bld.extension.CheckstyleOperation
-
Prints the Abstract Syntax Tree with Javadoc nodes included.
V
- valueOf(String) - Static method in enum class rife.bld.extension.checkstyle.OutputFormat
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class rife.bld.extension.checkstyle.OutputFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
X
- XML - Enum constant in enum class rife.bld.extension.checkstyle.OutputFormat
-
Extensible Markup Language (XML) output format.
All Classes and Interfaces|All Packages