Package rife.bld.extension

Class DetektOperation

java.lang.Object

rife.bld.operations.AbstractOperation<T>

rife.bld.operations.AbstractProcessOperation<DetektOperation>

rife.bld.extension.DetektOperation

@NullMarked
public class DetektOperation
extends AbstractProcessOperation<DetektOperation>

Performs static code analysis with Detekt.

Since:

1.0

Author:

Erik C. Thauvin

Field Summary

Fields inherited from class rife.bld.operations.AbstractProcessOperation

DEFAULT_JAVA_TOOL, environment_, errorProcessor_, errorProcessorThread_, javaOptions_, javaTool_, mainClass_, module_, modulePath_, outputProcessor_, outputProcessorThread_, process_, successful_, workDirectory_

Constructor Summary

Constructors

Constructor	Description
DetektOperation()

Method Summary

Modifier and Type	Method	Description
DetektOperation	allRules(boolean allRules)	Activates all available (even unstable) rules.
DetektOperation	analysisMode(AnalysisMode mode)	Sets the analysis mode used by detekt.
DetektOperation	apiVersion(@Nullable ApiVersion version)	Kotlin API version used by the code under analysis.
DetektOperation	autoCorrect(boolean autoCorrect)	Allow rules to autocorrect code if they support it.
@Nullable String	baseline()	Retrieves the baseline XML file.
DetektOperation	baseline(File baseline)	If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.
DetektOperation	baseline(String baseline)	If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.
DetektOperation	baseline(Path baseline)	If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.
@Nullable String	basePath()	Retrieves the base path.
DetektOperation	basePath(File path)	Specifies a directory as the base path.
DetektOperation	basePath(String path)	Specifies a directory as the base path.
DetektOperation	basePath(Path path)	Specifies a directory as the base path.
DetektOperation	buildUponDefaultConfig(boolean buildUponDefaultConfig)	Preconfigures detekt with a bunch of rules and some opinionated default for you.
List<File>	classPath()	Paths where to find user class files and jar dependencies.
DetektOperation	classPath(File... paths)	Paths where to find user class files and jar dependencies.
DetektOperation	classPath(String... paths)	Paths where to find user class files and jar dependencies.
DetektOperation	classPath(Path... paths)	Paths where to find user class files and jar dependencies.
final DetektOperation	classPath(Collection<File> paths)	Paths where to find user class files and jar dependencies.
final DetektOperation	classPathPaths(Collection<Path> paths)	Paths where to find user class files and jar dependencies.
final DetektOperation	classPathStrings(Collection<String> paths)	Paths where to find user class files and jar dependencies.
List<File>	config()	Paths to config files.
DetektOperation	config(File... configs)	Paths to the config files (path/to/config.yml).
DetektOperation	config(String... configs)	Paths to the config files (path/to/config.yml).
DetektOperation	config(Path... configs)	Paths to the config files (path/to/config.yml).
final DetektOperation	config(Collection<File> configs)	Paths to the config files (path/to/config.yml).
final DetektOperation	configPaths(Collection<Path> configs)	Paths to the config files (path/to/config.yml).
@Nullable String	configResource()	Retrieves the path of the config resource.
DetektOperation	configResource(File resource)	Path to the config resource on detekt's classpath (path/to/config.yml).
DetektOperation	configResource(String resource)	Path to the config resource on detekt's classpath (path/to/config.yml).
DetektOperation	configResource(Path resource)	Path to the config resource on detekt's classpath (path/to/config.yml).
final DetektOperation	configStrings(Collection<String> configs)	Paths to the config files (path/to/config.yml).
DetektOperation	createBaseline(boolean createBaseline)	Treats current analysis findings as a smell baseline for future detekt runs.
DetektOperation	debug(boolean debug)	Prints extra information about configurations and extensions.
DetektOperation	disableDefaultRuleSets(boolean disable)	Disables default rule sets.
List<String>	excludes()	Returns the globbing patterns describing paths to exclude from the analysis.
DetektOperation	excludes(String... patterns)	Globbing patterns describing paths to exclude from the analysis.
final DetektOperation	excludes(Collection<String> patterns)	Globbing patterns describing paths to exclude from the analysis.
void	execute()	Performs the operation.
protected List<String>	executeConstructProcessCommandList()	Part of the execute() operation, constructs the command list to use for building the process.
DetektOperation	failOnSeverity(Severity severity)	Specifies the minimum severity that causes the build to fail.
DetektOperation	fromProject(BaseProject project)	Configures the operation from a BaseProject.
@Nullable String	generateConfig()	Retrieves the path of the generated config.
DetektOperation	generateConfig(File path)	Export default config to the provided path.
DetektOperation	generateConfig(String path)	Export default config to the provided path.
DetektOperation	generateConfig(Path path)	Export default config to the provided path.
List<String>	includes()	Returns the globbing patterns describing paths to include in the analysis.
DetektOperation	includes(String... patterns)	Globbing patterns describing paths to include in the analysis.
final DetektOperation	includes(Collection<String> patterns)	Globbing patterns describing paths to include in the analysis.
List<File>	input()	Returns the input paths to analyze.
DetektOperation	input(File... paths)	Input paths to analyze.
DetektOperation	input(String... paths)	Input paths to analyze
DetektOperation	input(Path... paths)	Input paths to analyze.
final DetektOperation	input(Collection<File> paths)	Input paths to analyze.
final DetektOperation	inputPaths(Collection<Path> paths)	Input paths to analyze.
final DetektOperation	inputStrings(Collection<String> paths)	Input paths to analyze.
@Nullable String	jdkHome()	Retrieves the JDK home directory.
DetektOperation	jdkHome(File path)	Use a custom JDK home directory to include into the classpath.
DetektOperation	jdkHome(String path)	Use a custom JDK home directory to include into the classpath.
DetektOperation	jdkHome(Path path)	Use a custom JDK home directory to include into the classpath.
DetektOperation	jvmTarget(JvmTarget target)	Target version of the generated JVM bytecode that was generated during compilation and is now being used for type resolution.
DetektOperation	languageVersion(@Nullable LanguageVersion version)	Compatibility mode for Kotlin language version X.Y, reports errors for all language features that came out later.
DetektOperation	parallel(boolean parallel)	Enables parallel compilation and analysis of source files.
List<File>	plugins()	Extra path to plugins jars.
DetektOperation	plugins(File... jars)	Extra paths to plugin jars.
DetektOperation	plugins(String... jars)	Extra paths to plugin jars.
DetektOperation	plugins(Path... jars)	Extra paths to plugin jars.
final DetektOperation	plugins(Collection<File> jars)	Extra paths to plugin jars.
final DetektOperation	pluginsPaths(Collection<Path> jars)	Extra paths to plugin jars.
final DetektOperation	pluginsStrings(Collection<String> jars)	Extra paths to plugin jars.
DetektOperation	report(Report... reports)	Generates a report for given report-id and stores it on given 'path'.

Methods inherited from class rife.bld.operations.AbstractProcessOperation

classpath, classpath, classpath, classpath, classpath, environment, environment, environment, errorProcessor, errorProcessor, executeStartProcess, javaOptions, javaOptions, javaTool, javaTool, mainClass, mainClass, module, module, modulePath, modulePath, modulePath, modulePath, modulePath, outputProcessor, outputProcessor, process, workDirectory, workDirectory

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent, verbose, verbose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DetektOperation

public DetektOperation()

Method Details

execute

public void execute()
             throws IOException,
InterruptedException,
ExitStatusException

Performs the operation.

Overrides:

execute in class AbstractProcessOperation<DetektOperation>

Throws:

InterruptedException - when the operation was interrupted

IOException - when an exception occurred during the execution of the process

ExitStatusException - when the exit status was changed during the operation

NullPointerException - if project is null

executeConstructProcessCommandList

protected List<String> executeConstructProcessCommandList()

Part of the execute() operation, constructs the command list to use for building the process.

Specified by:

executeConstructProcessCommandList in class AbstractProcessOperation<DetektOperation>

fromProject

public DetektOperation fromProject(BaseProject project)

Configures the operation from a BaseProject.

Sets the following:

• The baseline to detekt-baseline.xml, if it exists in the project's work directory
• The excludes to exclude build and resources directories, if not already set
• The Detekt classpath from JARS in the project's bld lib directory

Specified by:

fromProject in class AbstractProcessOperation<DetektOperation>

Parameters:

project - the project to configure the operation from

Returns:

this operation instance

Throws:

NullPointerException - if project is null

allRules

public DetektOperation allRules(boolean allRules)

Activates all available (even unstable) rules.

Default is false

Parameters:

allRules - true or false

Returns:

this operation instance

analysisMode

public DetektOperation analysisMode(AnalysisMode mode)

Sets the analysis mode used by detekt.

• AnalysisMode.FULL - Comprehensive but requires the correct compiler options to be provided.
• AnalysisMode.LIGHT - Cannot utilize compiler information and some rules cannot be run in this mode.

Default is AnalysisMode.LIGHT

Parameters:

mode - the analysis mode

Returns:

this operation instance

Throws:

NullPointerException - if mode is null

apiVersion

public DetektOperation apiVersion(@Nullable ApiVersion version)

Kotlin API version used by the code under analysis.

Some rules use this information to provide more specific rule violation messages.

Parameters:

version - the api version

Returns:

this operation instance

autoCorrect

public DetektOperation autoCorrect(boolean autoCorrect)

Allow rules to autocorrect code if they support it.

The default rule sets do NOT support autocorrecting and won't change any line in the users code base. However, custom rules can be written to support autocorrecting. The additional 'ktlint' rule set, added with Plugins, does support it and needs this flag.

Default is false

Parameters:

autoCorrect - true or false

Returns:

this operation instance

basePath

public DetektOperation basePath(String path)

Specifies a directory as the base path.

Currently, it impacts all file paths in the formatted reports. File paths in console output are not affected and remain as absolute paths.

Parameters:

path - the directory path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

IllegalArgumentException - if path is empty or blank

See Also:

• basePath(File)
• basePath(Path)
• basePath()

basePath

public DetektOperation basePath(File path)

Specifies a directory as the base path.

Currently, it impacts all file paths in the formatted reports. File paths in console output are not affected and remain as absolute paths.

Parameters:

path - the directory path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

See Also:

• basePath(String)
• basePath(Path)
• basePath()

basePath

public @Nullable String basePath()

Retrieves the base path.

Returns:

the directory path

See Also:

• basePath(String)
• basePath(File)
• basePath(Path)

basePath

public DetektOperation basePath(Path path)

Specifies a directory as the base path.

Currently, it impacts all file paths in the formatted reports. File paths in console output are not affected and remain as absolute paths.

Parameters:

path - the directory path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

See Also:

• basePath(String)
• basePath(File)
• basePath()

baseline

public DetektOperation baseline(String baseline)

If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.

Parameters:

baseline - the baseline XML file

Returns:

this operation instance

Throws:

NullPointerException - if baseline is null

IllegalArgumentException - if baseline is empty or blank

See Also:

• baseline(File)
• baseline(Path)
• baseline()

baseline

public DetektOperation baseline(File baseline)

If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.

Parameters:

baseline - the baseline XML file

Returns:

this operation instance

Throws:

NullPointerException - if baseline is null

See Also:

• baseline(String)
• baseline(Path)
• baseline()

baseline

public DetektOperation baseline(Path baseline)

If a baseline XML file is passed in, only new code smells not in the baseline are printed in the console.

Parameters:

baseline - the baseline XML file

Returns:

this operation instance

Throws:

NullPointerException - if baseline is null

See Also:

• baseline(String)
• baseline(File)
• baseline()

baseline

public @Nullable String baseline()

Retrieves the baseline XML file.

Returns:

the baseline XML file

See Also:

• baseline(String)
• baseline(File)
• baseline(Path)

buildUponDefaultConfig

public DetektOperation buildUponDefaultConfig(boolean buildUponDefaultConfig)

Preconfigures detekt with a bunch of rules and some opinionated default for you.

Allows additional provided configurations to override the defaults.

Parameters:

buildUponDefaultConfig - true or false

Returns:

this operation instance

classPath

public DetektOperation classPath(File... paths)

Paths where to find user class files and jar dependencies.

Used for type resolution.

Parameters:

paths - one or more files

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• classPath(Path...)
• classPath(String...)
• classPath(Collection)
• classPathPaths(Collection)
• classPathStrings(Collection)
• classPath()

classPath

public DetektOperation classPath(Path... paths)

Paths where to find user class files and jar dependencies.

Used for type resolution.

Parameters:

paths - one or more files

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• classPath(File...)
• classPath(String...)
• classPath(Collection)
• classPathPaths(Collection)
• classPathStrings(Collection)
• classPath()

classPath

public DetektOperation classPath(String... paths)

Paths where to find user class files and jar dependencies.

Used for type resolution.

Parameters:

paths - one or more files

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty or contains empty elements

See Also:

• classPath(File...)
• classPath(Path...)
• classPath(Collection)
• classPathPaths(Collection)
• classPathStrings(Collection)
• classPath()

classPath

public final DetektOperation classPath(Collection<File> paths)

Paths where to find user class files and jar dependencies.

Used for type resolution.

Parameters:

paths - the paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• classPath(File...)
• classPath(Path...)
• classPath(String...)
• classPathPaths(Collection)
• classPathStrings(Collection)
• classPath()

classPath

public List<File> classPath()

Paths where to find user class files and jar dependencies.

Returns:

the classpath

classPathPaths

public final DetektOperation classPathPaths(Collection<Path> paths)

Paths where to find user class files and jar dependencies.

Used for type resolution.

Parameters:

paths - the paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• classPath(File...)
• classPath(Path...)
• classPath(String...)
• classPath(Collection)
• classPathStrings(Collection)
• classPath()

classPathStrings

public final DetektOperation classPathStrings(Collection<String> paths)

Paths where to find user class files and jar dependencies.

Used for type resolution.

Parameters:

paths - the paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty or contains empty elements

See Also:

• classPath(File...)
• classPath(Path...)
• classPath(String...)
• classPath(Collection)
• classPathPaths(Collection)
• classPath()

config

public DetektOperation config(File... configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - one or more config files

Returns:

this operation instance

Throws:

NullPointerException - if configs is null or contains null elements

IllegalArgumentException - if configs is empty

See Also:

• config(Path...)
• config(String...)
• config(Collection)
• configPaths(Collection)
• configStrings(Collection)
• config()

config

public DetektOperation config(Path... configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - one or more config files

Returns:

this operation instance

Throws:

NullPointerException - if configs is null or contains null elements

IllegalArgumentException - if configs is empty

See Also:

• config(File...)
• config(String...)
• config(Collection)
• configPaths(Collection)
• configStrings(Collection)
• config()

config

public DetektOperation config(String... configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - one or more config files

Returns:

this operation instance

Throws:

NullPointerException - if configs is null or contains null elements

IllegalArgumentException - if configs is empty or contains empty elements

See Also:

• config(File...)
• config(Path...)
• config(Collection)
• configPaths(Collection)
• configStrings(Collection)
• config()

config

public final DetektOperation config(Collection<File> configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - the config files

Returns:

this operation instance

Throws:

NullPointerException - if configs is null or contains null elements

IllegalArgumentException - if configs is empty

See Also:

• config(File...)
• config(Path...)
• config(String...)
• configPaths(Collection)
• configStrings(Collection)
• config()

config

public List<File> config()

Paths to config files.

Returns:

the config files paths.

configPaths

public final DetektOperation configPaths(Collection<Path> configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - the config files

Returns:

this operation instance

Throws:

NullPointerException - if configs is null or contains null elements

IllegalArgumentException - if configs is empty

See Also:

• config(File...)
• config(Path...)
• config(String...)
• config(Collection)
• configStrings(Collection)
• config()

configResource

public DetektOperation configResource(String resource)

Path to the config resource on detekt's classpath (path/to/config.yml).

Parameters:

resource - the config resource path

Returns:

this operation instance

Throws:

NullPointerException - if resource is null

IllegalArgumentException - if resource is empty or blank

See Also:

• configResource(File)
• configResource(Path)
• configResource()

configResource

public DetektOperation configResource(File resource)

Path to the config resource on detekt's classpath (path/to/config.yml).

Parameters:

resource - the config resource path

Returns:

this operation instance

Throws:

NullPointerException - if resource is null

See Also:

• configResource(String)
• configResource(Path)
• configResource()

configResource

public DetektOperation configResource(Path resource)

Path to the config resource on detekt's classpath (path/to/config.yml).

Parameters:

resource - the config resource path

Returns:

this operation instance

Throws:

NullPointerException - if resource is null

See Also:

• configResource(String)
• configResource(File)
• configResource()

configResource

public @Nullable String configResource()

Retrieves the path of the config resource.

Returns:

the config resource path

See Also:

• configResource(String)
• configResource(File)
• configResource(Path)

configStrings

public final DetektOperation configStrings(Collection<String> configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - the config files

Returns:

this operation instance

Throws:

NullPointerException - if configs is null or contains null elements

IllegalArgumentException - if configs is empty or contains empty elements

See Also:

• config(File...)
• config(Path...)
• config(String...)
• config(Collection)
• configPaths(Collection)
• config()

createBaseline

public DetektOperation createBaseline(boolean createBaseline)

Treats current analysis findings as a smell baseline for future detekt runs.

Default is false

Parameters:

createBaseline - true or false

Returns:

this operation instance

debug

public DetektOperation debug(boolean debug)

Prints extra information about configurations and extensions.

Default is false

Parameters:

debug - true or false

Returns:

this operation instance

disableDefaultRuleSets

public DetektOperation disableDefaultRuleSets(boolean disable)

Disables default rule sets.

Default is false

Parameters:

disable - true or false

Returns:

this operation instance

excludes

public DetektOperation excludes(String... patterns)

Globbing patterns describing paths to exclude from the analysis.

Parameters:

patterns - one or more pattern

Returns:

this operation instance

Throws:

NullPointerException - if patterns is null or contains null elements

IllegalArgumentException - if patterns is empty or contains empty elements

See Also:

• excludes(Collection)
• excludes()

excludes

public final DetektOperation excludes(Collection<String> patterns)

Globbing patterns describing paths to exclude from the analysis.

Parameters:

patterns - a collection of patterns

Returns:

this operation instance

Throws:

NullPointerException - if patterns is null or contains null elements

IllegalArgumentException - if patterns is empty or contains empty elements

See Also:

• excludes(String...)
• excludes()

excludes

public List<String> excludes()

Returns the globbing patterns describing paths to exclude from the analysis.

Returns:

the globbing patterns

failOnSeverity

public DetektOperation failOnSeverity(Severity severity)

Specifies the minimum severity that causes the build to fail.

When the value is set to Severity.NEVER detekt will not fail regardless of the number of issues and their severities.

Default is Severity.ERROR

Parameters:

severity - the severity

Returns:

this operation instance

Throws:

NullPointerException - if severity is null

generateConfig

public DetektOperation generateConfig(String path)

Export default config to the provided path.

Parameters:

path - the path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

IllegalArgumentException - if path is empty or blank

See Also:

• generateConfig(File)
• generateConfig(Path)
• generateConfig()

generateConfig

public DetektOperation generateConfig(File path)

Export default config to the provided path.

Parameters:

path - the path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

See Also:

• generateConfig(String)
• generateConfig(Path)
• generateConfig()

generateConfig

public DetektOperation generateConfig(Path path)

Export default config to the provided path.

Parameters:

path - the path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

See Also:

• generateConfig(String)
• generateConfig(File)
• generateConfig()

generateConfig

public @Nullable String generateConfig()

Retrieves the path of the generated config.

Returns:

the config path

See Also:

• generateConfig(String)
• generateConfig(File)
• generateConfig(Path)

includes

public DetektOperation includes(String... patterns)

Globbing patterns describing paths to include in the analysis.

Useful in combination with excludes patterns.

Parameters:

patterns - one or more patterns

Returns:

this operation instance

Throws:

NullPointerException - if patterns is null or contains null elements

IllegalArgumentException - if patterns is empty or contains empty elements

See Also:

• includes(Collection)
• includes()

includes

public final DetektOperation includes(Collection<String> patterns)

Globbing patterns describing paths to include in the analysis.

Useful in combination with excludes patterns.

Parameters:

patterns - a collection of patterns

Returns:

this operation instance

Throws:

NullPointerException - if patterns is null or contains null elements

IllegalArgumentException - if patterns is empty or contains empty elements

See Also:

• includes(String...)
• includes()

includes

public List<String> includes()

Returns the globbing patterns describing paths to include in the analysis.

Returns:

the globbing patterns

input

public final DetektOperation input(Collection<File> paths)

Input paths to analyze.

If not specified the current working directory is used.

Parameters:

paths - the paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• input(File...)
• input(Path...)
• input(String...)
• inputPaths(Collection)
• inputStrings(Collection)
• input()

input

public DetektOperation input(String... paths)

Input paths to analyze

If not specified the current working directory is used.

Parameters:

paths - one or more paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty or contains empty elements

See Also:

• input(File...)
• input(Path...)
• input(Collection)
• inputPaths(Collection)
• inputStrings(Collection)
• input()

input

public DetektOperation input(File... paths)

Input paths to analyze.

If not specified the current working directory is used.

Parameters:

paths - one or more paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• input(Path...)
• input(String...)
• input(Collection)
• inputPaths(Collection)
• inputStrings(Collection)
• input()

input

public DetektOperation input(Path... paths)

Input paths to analyze.

If not specified the current working directory is used.

Parameters:

paths - one or more paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• input(File...)
• input(String...)
• input(Collection)
• inputPaths(Collection)
• inputStrings(Collection)
• input()

input

public List<File> input()

Returns the input paths to analyze.

Returns:

the input paths

inputPaths

public final DetektOperation inputPaths(Collection<Path> paths)

Input paths to analyze.

If not specified the current working directory is used.

Parameters:

paths - the paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty

See Also:

• input(File...)
• input(Path...)
• input(String...)
• input(Collection)
• inputStrings(Collection)
• input()

inputStrings

public final DetektOperation inputStrings(Collection<String> paths)

Input paths to analyze.

If not specified the current working directory is used.

Parameters:

paths - the paths

Returns:

this operation instance

Throws:

NullPointerException - if paths is null or contains null elements

IllegalArgumentException - if paths is empty or contains empty elements

See Also:

• input(File...)
• input(Path...)
• input(String...)
• input(Collection)
• inputPaths(Collection)
• input()

jdkHome

public DetektOperation jdkHome(String path)

Use a custom JDK home directory to include into the classpath.

Parameters:

path - the JDK home directory path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

IllegalArgumentException - if path is blank

See Also:

• jdkHome(File)
• jdkHome(Path)
• jdkHome()

jdkHome

public DetektOperation jdkHome(File path)

Use a custom JDK home directory to include into the classpath.

Parameters:

path - the JDK home directory path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

See Also:

• jdkHome(String)
• jdkHome(Path)
• jdkHome()

jdkHome

public DetektOperation jdkHome(Path path)

Use a custom JDK home directory to include into the classpath.

Parameters:

path - the JDK home directory path

Returns:

this operation instance

Throws:

NullPointerException - if path is null

See Also:

• jdkHome(String)
• jdkHome(File)
• jdkHome()

jdkHome

public @Nullable String jdkHome()

Retrieves the JDK home directory.

Returns:

the JDK home directory path

See Also:

• jdkHome(String)
• jdkHome(File)
• jdkHome(Path)

jvmTarget

public DetektOperation jvmTarget(JvmTarget target)

Target version of the generated JVM bytecode that was generated during compilation and is now being used for type resolution.

Default: 1.8

Parameters:

target - the target version

Returns:

this operation instance

Throws:

NullPointerException - if target is null

languageVersion

public DetektOperation languageVersion(@Nullable LanguageVersion version)

Compatibility mode for Kotlin language version X.Y, reports errors for all language features that came out later.

Parameters:

version - the version

Returns:

this operation instance

Throws:

NullPointerException - if version is null

parallel

public DetektOperation parallel(boolean parallel)

Enables parallel compilation and analysis of source files.

Do some benchmarks first before enabling this flag. Heuristics show performance benefits starting from 000 lines of Kotlin code.

Default is false

Parameters:

parallel - true or false

Returns:

this operation instance

plugins

public DetektOperation plugins(String... jars)

Extra paths to plugin jars.

Parameters:

jars - one or more jars

Returns:

this operation instance

Throws:

NullPointerException - if jars is null or contains null elements

IllegalArgumentException - if jars is empty or contains empty elements

See Also:

• plugins(File...)
• plugins(Path...)
• plugins(Collection)
• pluginsPaths(Collection)
• pluginsStrings(Collection)
• plugins()

plugins

public DetektOperation plugins(File... jars)

Extra paths to plugin jars.

Parameters:

jars - one or more jars

Returns:

this operation instance

Throws:

NullPointerException - if jars is null or contains null elements

IllegalArgumentException - if jars is empty

See Also:

• plugins(Path...)
• plugins(String...)
• plugins(Collection)
• pluginsPaths(Collection)
• pluginsStrings(Collection)
• plugins()

plugins

public DetektOperation plugins(Path... jars)

Extra paths to plugin jars.

Parameters:

jars - one or more jars

Returns:

this operation instance

Throws:

NullPointerException - if jars is null or contains null elements

IllegalArgumentException - if jars is empty

See Also:

• plugins(File...)
• plugins(String...)
• plugins(Collection)
• pluginsPaths(Collection)
• pluginsStrings(Collection)
• plugins()

plugins

public final DetektOperation plugins(Collection<File> jars)

Extra paths to plugin jars.

Parameters:

jars - the jars paths

Returns:

this operation instance

Throws:

NullPointerException - if jars is null or contains null elements

IllegalArgumentException - if jars is empty

See Also:

• plugins(File...)
• plugins(Path...)
• plugins(String...)
• pluginsPaths(Collection)
• pluginsStrings(Collection)
• plugins()

plugins

public List<File> plugins()

Extra path to plugins jars.

Returns:

the jars paths

pluginsPaths

public final DetektOperation pluginsPaths(Collection<Path> jars)

Extra paths to plugin jars.

Parameters:

jars - the jars paths

Returns:

this operation instance

Throws:

NullPointerException - if jars is null or contains null elements

IllegalArgumentException - if jars is empty

See Also:

• plugins(File...)
• plugins(Path...)
• plugins(String...)
• plugins(Collection)
• pluginsStrings(Collection)
• plugins()

pluginsStrings

public final DetektOperation pluginsStrings(Collection<String> jars)

Extra paths to plugin jars.

Parameters:

jars - the jars paths

Returns:

this operation instance

Throws:

NullPointerException - if jars is null or contains null elements

IllegalArgumentException - if jars is empty or contains empty elements

See Also:

• plugins(File...)
• plugins(Path...)
• plugins(String...)
• plugins(Collection)
• pluginsPaths(Collection)
• plugins()

report

public DetektOperation report(Report... reports)

Generates a report for given report-id and stores it on given 'path'.

Parameters:

reports - one or more reports

Returns:

this operation instance

Throws:

NullPointerException - if reports is null or contains null elements

IllegalArgumentException - if reports is empty