Index
All Classes and Interfaces|All Packages
A
- allRules(boolean) - Method in class rife.bld.extension.DetektOperation
-
Activates all available (even unstable) rules.
- analysisMode(AnalysisMode) - Method in class rife.bld.extension.DetektOperation
-
Sets the analysis mode used by detekt.
- AnalysisMode - Enum Class in rife.bld.extension.detekt
-
Analysis mode.
- apiVersion(ApiVersion) - Method in class rife.bld.extension.DetektOperation
-
Kotlin API version used by the code under analysis.
- ApiVersion - Enum Class in rife.bld.extension.detekt
-
Kotlin API version used by the code under analysis.
- autoCorrect(boolean) - Method in class rife.bld.extension.DetektOperation
-
Allow rules to autocorrect code if they support it.
B
- baseline() - Method in class rife.bld.extension.DetektOperation
-
Retrieves the baseline XML file.
- baseline(File) - Method in class rife.bld.extension.DetektOperation
-
If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.
- baseline(String) - Method in class rife.bld.extension.DetektOperation
-
If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.
- baseline(Path) - Method in class rife.bld.extension.DetektOperation
-
If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.
- basePath() - Method in class rife.bld.extension.DetektOperation
-
Retrieves the base path.
- basePath(File) - Method in class rife.bld.extension.DetektOperation
-
Specifies a directory as the base path.
- basePath(String) - Method in class rife.bld.extension.DetektOperation
-
Specifies a directory as the base path.
- basePath(Path) - Method in class rife.bld.extension.DetektOperation
-
Specifies a directory as the base path.
- buildUponDefaultConfig(boolean) - Method in class rife.bld.extension.DetektOperation
-
Preconfigures detekt with a bunch of rules and some opinionated default for you.
C
- CHECKSTYLE - Enum constant in enum class rife.bld.extension.detekt.ReportId
- classPath() - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- classPath(File...) - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- classPath(String...) - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- classPath(Path...) - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- classPath(Collection<File>) - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- classPathPaths(Collection<Path>) - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- classPathStrings(Collection<String>) - Method in class rife.bld.extension.DetektOperation
-
Paths where to find user class files and jar dependencies.
- config() - Method in class rife.bld.extension.DetektOperation
-
Paths to config files.
- config(File...) - Method in class rife.bld.extension.DetektOperation
-
Paths to the config files (
path/to/config.yml). - config(String...) - Method in class rife.bld.extension.DetektOperation
-
Paths to the config files (
path/to/config.yml). - config(Path...) - Method in class rife.bld.extension.DetektOperation
-
Paths to the config files (
path/to/config.yml). - config(Collection<File>) - Method in class rife.bld.extension.DetektOperation
-
Paths to the config files (
path/to/config.yml). - configPaths(Collection<Path>) - Method in class rife.bld.extension.DetektOperation
-
Paths to the config files (
path/to/config.yml). - configResource() - Method in class rife.bld.extension.DetektOperation
-
Retrieves the path of the config resource.
- configResource(File) - Method in class rife.bld.extension.DetektOperation
-
Path to the config resource on detekt's classpath (
path/to/config.yml). - configResource(String) - Method in class rife.bld.extension.DetektOperation
-
Path to the config resource on detekt's classpath (
path/to/config.yml). - configResource(Path) - Method in class rife.bld.extension.DetektOperation
-
Path to the config resource on detekt's classpath (
path/to/config.yml). - configStrings(Collection<String>) - Method in class rife.bld.extension.DetektOperation
-
Paths to the config files (
path/to/config.yml). - createBaseline(boolean) - Method in class rife.bld.extension.DetektOperation
-
Treats current analysis findings as a smell baseline for future detekt runs.
D
- debug(boolean) - Method in class rife.bld.extension.DetektOperation
-
Prints extra information about configurations and extensions.
- DetektOperation - Class in rife.bld.extension
-
Performs static code analysis with Detekt.
- DetektOperation() - Constructor for class rife.bld.extension.DetektOperation
- disableDefaultRuleSets(boolean) - Method in class rife.bld.extension.DetektOperation
-
Disables default rule sets.
E
- equals(Object) - Method in record class rife.bld.extension.detekt.Report
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class rife.bld.extension.detekt.Severity
- excludes() - Method in class rife.bld.extension.DetektOperation
-
Returns the globbing patterns describing paths to exclude from the analysis.
- excludes(String...) - Method in class rife.bld.extension.DetektOperation
-
Globbing patterns describing paths to exclude from the analysis.
- excludes(Collection<String>) - Method in class rife.bld.extension.DetektOperation
-
Globbing patterns describing paths to exclude from the analysis.
- execute() - Method in class rife.bld.extension.DetektOperation
-
Performs the operation.
- executeConstructProcessCommandList() - Method in class rife.bld.extension.DetektOperation
-
Part of the
DetektOperation.execute()operation, constructs the command list to use for building the process.
F
- failOnSeverity(Severity) - Method in class rife.bld.extension.DetektOperation
-
Specifies the minimum severity that causes the build to fail.
- fromProject(BaseProject) - Method in class rife.bld.extension.DetektOperation
-
Configures the operation from a
BaseProject. - FULL - Enum constant in enum class rife.bld.extension.detekt.AnalysisMode
-
Comprehensive but requires the correct compiler options to be provided.
G
- generateConfig() - Method in class rife.bld.extension.DetektOperation
-
Retrieves the path of the generated config.
- generateConfig(File) - Method in class rife.bld.extension.DetektOperation
-
Export default config to the provided path.
- generateConfig(String) - Method in class rife.bld.extension.DetektOperation
-
Export default config to the provided path.
- generateConfig(Path) - Method in class rife.bld.extension.DetektOperation
-
Export default config to the provided path.
H
- hashCode() - Method in record class rife.bld.extension.detekt.Report
-
Returns a hash code value for this object.
- HTML - Enum constant in enum class rife.bld.extension.detekt.ReportId
I
- id() - Method in record class rife.bld.extension.detekt.Report
-
Returns the value of the
idrecord component. - includes() - Method in class rife.bld.extension.DetektOperation
-
Returns the globbing patterns describing paths to include in the analysis.
- includes(String...) - Method in class rife.bld.extension.DetektOperation
-
Globbing patterns describing paths to include in the analysis.
- includes(Collection<String>) - Method in class rife.bld.extension.DetektOperation
-
Globbing patterns describing paths to include in the analysis.
- INFO - Enum constant in enum class rife.bld.extension.detekt.Severity
- input() - Method in class rife.bld.extension.DetektOperation
-
Returns the input paths to analyze.
- input(File...) - Method in class rife.bld.extension.DetektOperation
-
Input paths to analyze.
- input(String...) - Method in class rife.bld.extension.DetektOperation
-
Input paths to analyze
- input(Path...) - Method in class rife.bld.extension.DetektOperation
-
Input paths to analyze.
- input(Collection<File>) - Method in class rife.bld.extension.DetektOperation
-
Input paths to analyze.
- inputPaths(Collection<Path>) - Method in class rife.bld.extension.DetektOperation
-
Input paths to analyze.
- inputStrings(Collection<String>) - Method in class rife.bld.extension.DetektOperation
-
Input paths to analyze.
J
- jdkHome() - Method in class rife.bld.extension.DetektOperation
-
Retrieves the JDK home directory.
- jdkHome(File) - Method in class rife.bld.extension.DetektOperation
-
Use a custom JDK home directory to include into the classpath.
- jdkHome(String) - Method in class rife.bld.extension.DetektOperation
-
Use a custom JDK home directory to include into the classpath.
- jdkHome(Path) - Method in class rife.bld.extension.DetektOperation
-
Use a custom JDK home directory to include into the classpath.
- JVM_1_6 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_1_8 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_10 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_11 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_12 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_13 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_14 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_15 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_16 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_17 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_18 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_19 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_20 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_21 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_22 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_23 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_24 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_25 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_26 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- JVM_9 - Enum constant in enum class rife.bld.extension.detekt.JvmTarget
- jvmTarget(JvmTarget) - Method in class rife.bld.extension.DetektOperation
-
Target version of the generated JVM bytecode that was generated during compilation and is now being used for type resolution.
- JvmTarget - Enum Class in rife.bld.extension.detekt
-
Target version of the generated JVM bytecode.
L
- languageVersion(LanguageVersion) - Method in class rife.bld.extension.DetektOperation
-
Compatibility mode for Kotlin language version X.Y, reports errors for all language features that came out later.
- LanguageVersion - Enum Class in rife.bld.extension.detekt
-
Compatibility mode for Kotlin language version X.Y.
- LIGHT - Enum constant in enum class rife.bld.extension.detekt.AnalysisMode
-
Analysis cannot utilize compiler information and some rules cannot be run in this mode.
M
N
- NEVER - Enum constant in enum class rife.bld.extension.detekt.Severity
-
Detekt will never fail regardless of the number of issues and their severities.
P
- parallel(boolean) - Method in class rife.bld.extension.DetektOperation
-
Enables parallel compilation and analysis of source files.
- path() - Method in record class rife.bld.extension.detekt.Report
-
Returns the value of the
pathrecord component. - plugins() - Method in class rife.bld.extension.DetektOperation
-
Extra path to plugins jars.
- plugins(File...) - Method in class rife.bld.extension.DetektOperation
-
Extra paths to plugin jars.
- plugins(String...) - Method in class rife.bld.extension.DetektOperation
-
Extra paths to plugin jars.
- plugins(Path...) - Method in class rife.bld.extension.DetektOperation
-
Extra paths to plugin jars.
- plugins(Collection<File>) - Method in class rife.bld.extension.DetektOperation
-
Extra paths to plugin jars.
- pluginsPaths(Collection<Path>) - Method in class rife.bld.extension.DetektOperation
-
Extra paths to plugin jars.
- pluginsStrings(Collection<String>) - Method in class rife.bld.extension.DetektOperation
-
Extra paths to plugin jars.
R
- report(Report...) - Method in class rife.bld.extension.DetektOperation
-
Generates a report for given
report-idand stores it on given 'path'. - Report - Record Class in rife.bld.extension.detekt
-
Defines a report for the given report-id to be stored on the given path.
- Report(ReportId, String) - Constructor for record class rife.bld.extension.detekt.Report
-
Creates an instance of a
Reportrecord class. - ReportId - Enum Class in rife.bld.extension.detekt
-
The report-id values.
- rife.bld.extension - package rife.bld.extension
- rife.bld.extension.detekt - package rife.bld.extension.detekt
-
Defines values and data storage for reports.
S
- SARIF - Enum constant in enum class rife.bld.extension.detekt.ReportId
- Severity - Enum Class in rife.bld.extension.detekt
-
Severity that cause the build to fail.
T
- toString() - Method in enum class rife.bld.extension.detekt.AnalysisMode
- toString() - Method in enum class rife.bld.extension.detekt.ApiVersion
- toString() - Method in enum class rife.bld.extension.detekt.JvmTarget
- toString() - Method in enum class rife.bld.extension.detekt.LanguageVersion
- toString() - Method in record class rife.bld.extension.detekt.Report
-
Returns a string representation of this record class.
- toString() - Method in enum class rife.bld.extension.detekt.Severity
V
- V_1_0 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_0 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_1 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_1 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_2 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_2 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_3 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_3 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_4 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_4 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_5 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_5 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_6 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_6 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_7 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_7 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_8 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_8 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_1_9 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_1_9 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_2_0 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_2_0 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_2_1 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_2_1 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_2_2 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_2_2 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_2_3 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_2_3 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_2_4 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_2_4 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- V_2_5 - Enum constant in enum class rife.bld.extension.detekt.ApiVersion
- V_2_5 - Enum constant in enum class rife.bld.extension.detekt.LanguageVersion
- value() - Method in enum class rife.bld.extension.detekt.AnalysisMode
- value() - Method in enum class rife.bld.extension.detekt.Severity
- valueOf(String) - Static method in enum class rife.bld.extension.detekt.AnalysisMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class rife.bld.extension.detekt.ApiVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class rife.bld.extension.detekt.JvmTarget
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class rife.bld.extension.detekt.LanguageVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class rife.bld.extension.detekt.ReportId
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class rife.bld.extension.detekt.Severity
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class rife.bld.extension.detekt.AnalysisMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class rife.bld.extension.detekt.ApiVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class rife.bld.extension.detekt.JvmTarget
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class rife.bld.extension.detekt.LanguageVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class rife.bld.extension.detekt.ReportId
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class rife.bld.extension.detekt.Severity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in enum class rife.bld.extension.detekt.ApiVersion
- version() - Method in enum class rife.bld.extension.detekt.JvmTarget
- version() - Method in enum class rife.bld.extension.detekt.LanguageVersion
W
A B C D E F G H I J L M N P R S T V WAll Classes and Interfaces|All Packages