Package rife.bld.extension

Class ErrorProneOperation

java.lang.Object

rife.bld.operations.AbstractOperation<ErrorProneOperation>

rife.bld.extension.ErrorProneOperation

@NullMarked
public class ErrorProneOperation
extends AbstractOperation<ErrorProneOperation>

Compiles source code using Error Prone.

All javac diagnostics are reported, not just those of a failed compilation.

The Error Prone version defaults to ERROR_PRONE_VERSION on JDK 21+ and 2.42.0 on JDK 17-20.

Required JVM options in lib/bld/bld-wrapper.properties:

 bld.javaOptions=--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED\
   \ --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED\
   \ --add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED\
   \ --add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED
 

Since:

1.0

Author:

Erik C. Thauvin

Field Summary

Fields

Modifier and Type	Field	Description
static final Version	ERROR_PRONE_VERSION	The Error Prone version used on JDK 21 and newer.
static final Version	LAST_JDK17_VERSION	The Error Prone version used for JDK 17-20.

Constructor Summary

Constructors

Constructor	Description
ErrorProneOperation()

Method Summary

Modifier and Type	Method	Description
ErrorProneOperation	allDisabledChecksAsWarnings(boolean allDisabledChecksAsWarnings)	Reports all disabled-by-default checks as warnings (-XepAllDisabledChecksAsWarnings).
ErrorProneOperation	allErrorsAsWarnings(boolean allErrorsAsWarnings)	Reports all Error Prone errors as warnings (-XepAllErrorsAsWarnings).
ErrorProneOperation	allSuggestionsAsWarnings(boolean allSuggestionsAsWarnings)	Reports all suggestion-level findings as warnings (-XepAllSuggestionsAsWarnings).
ErrorProneOperation	compileOptions(Consumer<JavacOptions> customizer)	Configures the JavacOptions used for the compilation.
ErrorProneOperation	disableAllChecks(boolean disableAllChecks)	Disables all checks (-XepDisableAllChecks).
ErrorProneOperation	disableAllWarnings(boolean disableAllWarnings)	Disables all warning-level checks (-XepDisableAllWarnings).
ErrorProneOperation	disableCheck(String... names)	Disables Error Prone checks (-Xep:Check:OFF).
ErrorProneOperation	disableCheck(Collection<String> names)	Disables Error Prone checks (-Xep:Check:OFF).
ErrorProneOperation	disableWarningsInGeneratedCode(boolean disableWarningsInGeneratedCode)	Disables warnings in classes annotated with @Generated (-XepDisableWarningsInGeneratedCode).
ErrorProneOperation	enableCheck(String... names)	Enables Error Prone checks at the severity from their own definition (-Xep:Check).
ErrorProneOperation	enableCheck(Collection<String> names)	Enables Error Prone checks at the severity from their own definition (-Xep:Check).
ErrorProneOperation	errorCheck(String... names)	Sets Error Prone checks to report at error severity (-Xep:Check:ERROR).
ErrorProneOperation	errorCheck(Collection<String> names)	Sets Error Prone checks to report at error severity (-Xep:Check:ERROR).
ErrorProneOperation	excludedPath(String... regexes)	Excludes source paths from analysis (-XepExcludedPaths:regex).
ErrorProneOperation	excludedPath(Collection<String> regexes)	Excludes source paths from analysis (-XepExcludedPaths:regex).
ErrorProneOperation	excludedPath(Pattern... patterns)	Excludes source paths from analysis (-XepExcludedPaths:regex).
void	execute()	Compiles the project's main and test sources.
ErrorProneOperation	flag(String... flags)	Adds raw Error Prone flags.
ErrorProneOperation	fromProject(BaseProject project)	Configures the operation from a project.
ErrorProneOperation	ignoreUnknownCheckNames(boolean ignoreUnknownCheckNames)	Allows unknown check names instead of failing (-XepIgnoreUnknownCheckNames).
ErrorProneOperation	option(String name)	Sets a check option (-XepOpt:name).
ErrorProneOperation	option(String name, String value)	Sets a check option (-XepOpt:name=value).
ErrorProneOperation	patchChecks(String... checks)	Sets the checks whose suggested fixes are written as a patch (-XepPatchChecks:).
ErrorProneOperation	patchChecks(Collection<String> checks)	Sets the checks whose suggested fixes are written as a patch (-XepPatchChecks:).
ErrorProneOperation	patchLocation(String location)	Sets where patches are written (-XepPatchLocation:).
ErrorProneOperation	repositories(Collection<Repository> repositories)	Sets the repositories to download Error Prone from, replacing the current list.
ErrorProneOperation	repositories(Repository... repositories)	Sets the repositories to download Error Prone from, replacing the current list.
Version	version()	Returns the Error Prone version.
ErrorProneOperation	version(String version)	Sets the Error Prone version.
ErrorProneOperation	version(Version version)	Sets the Error Prone version.
ErrorProneOperation	warnCheck(String... names)	Sets Error Prone checks to report at warning severity (-Xep:Check:WARN).
ErrorProneOperation	warnCheck(Collection<String> names)	Sets Error Prone checks to report at warning severity (-Xep:Check:WARN).

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

Field Details

ERROR_PRONE_VERSION

public static final Version ERROR_PRONE_VERSION

The Error Prone version used on JDK 21 and newer.

Currently: 2.52.0

LAST_JDK17_VERSION

public static final Version LAST_JDK17_VERSION

The Error Prone version used for JDK 17-20.

Last: 2.42.0

Constructor Details

ErrorProneOperation

public ErrorProneOperation()

Method Details

execute

public void execute()
             throws Exception

Compiles the project's main and test sources.

Specified by:

execute in class AbstractOperation<ErrorProneOperation>

Throws:

NullPointerException - if no project was set

IllegalStateException - if the JDK is unsupported, the JVM lacks required --add-exports/ --add-opens, or the Error Prone jars can't be downloaded

Exception - if compilation fails

allDisabledChecksAsWarnings

public ErrorProneOperation allDisabledChecksAsWarnings(boolean allDisabledChecksAsWarnings)

Reports all disabled-by-default checks as warnings (-XepAllDisabledChecksAsWarnings).

Parameters:

allDisabledChecksAsWarnings - true to enable

Returns:

this operation

allErrorsAsWarnings

public ErrorProneOperation allErrorsAsWarnings(boolean allErrorsAsWarnings)

Reports all Error Prone errors as warnings (-XepAllErrorsAsWarnings).

Parameters:

allErrorsAsWarnings - true to downgrade

Returns:

this operation

allSuggestionsAsWarnings

public ErrorProneOperation allSuggestionsAsWarnings(boolean allSuggestionsAsWarnings)

Reports all suggestion-level findings as warnings (-XepAllSuggestionsAsWarnings).

Parameters:

allSuggestionsAsWarnings - true to report

Returns:

this operation

compileOptions

public ErrorProneOperation compileOptions(Consumer<JavacOptions> customizer)

Configures the JavacOptions used for the compilation.

Customizers run before the Error Prone options, so the operation's own options win.

A customizer-supplied --processor-path is merged with the Error Prone processor path.

Annotation processors that javac would otherwise discover on the classpath are no longer found because the operation always sets a processor path; add them with o.processorPath(...) if needed.

Parameters:

customizer - the customizer

Returns:

this operation

Throws:

NullPointerException - if customizer is null

disableAllChecks

public ErrorProneOperation disableAllChecks(boolean disableAllChecks)

Disables all checks (-XepDisableAllChecks).

Enable individual checks afterward with errorCheck(String...).

Parameters:

disableAllChecks - true to disable

Returns:

this operation

disableAllWarnings

public ErrorProneOperation disableAllWarnings(boolean disableAllWarnings)

Disables all warning-level checks (-XepDisableAllWarnings).

Parameters:

disableAllWarnings - true to disable

Returns:

this operation

disableCheck

public ErrorProneOperation disableCheck(Collection<String> names)

Disables Error Prone checks (-Xep:Check:OFF).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• disableCheck(String...)

disableCheck

public ErrorProneOperation disableCheck(String... names)

Disables Error Prone checks (-Xep:Check:OFF).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• disableCheck(Collection)

disableWarningsInGeneratedCode

public ErrorProneOperation disableWarningsInGeneratedCode(boolean disableWarningsInGeneratedCode)

Disables warnings in classes annotated with @Generated (-XepDisableWarningsInGeneratedCode).

Parameters:

disableWarningsInGeneratedCode - true to disable

Returns:

this operation

enableCheck

public ErrorProneOperation enableCheck(Collection<String> names)

Enables Error Prone checks at the severity from their own definition (-Xep:Check).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• enableCheck(String...)

enableCheck

public ErrorProneOperation enableCheck(String... names)

Enables Error Prone checks at the severity from their own definition (-Xep:Check).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• enableCheck(Collection)

errorCheck

public ErrorProneOperation errorCheck(Collection<String> names)

Sets Error Prone checks to report at error severity (-Xep:Check:ERROR).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• errorCheck(String...)

errorCheck

public ErrorProneOperation errorCheck(String... names)

Sets Error Prone checks to report at error severity (-Xep:Check:ERROR).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• errorCheck(Collection)

excludedPath

public ErrorProneOperation excludedPath(Collection<String> regexes)

Excludes source paths from analysis (-XepExcludedPaths:regex).

Values are joined with |.

The regex must not contain whitespace.

Parameters:

regexes - the regexes

Returns:

this operation

Throws:

NullPointerException - if regexes is null or contains null

IllegalArgumentException - if regexes is empty, or any regex is blank or contains whitespace or control characters

See Also:

• excludedPath(String...)
• excludedPath(Pattern...)

excludedPath

public ErrorProneOperation excludedPath(String... regexes)

Excludes source paths from analysis (-XepExcludedPaths:regex).

Values are joined with |.

The regex must not contain whitespace.

Parameters:

regexes - the regexes

Returns:

this operation

Throws:

NullPointerException - if regexes is null or contains null

IllegalArgumentException - if regexes is empty, or any regex is blank or contains whitespace or control characters

See Also:

• excludedPath(Collection)
• excludedPath(Pattern...)

excludedPath

public ErrorProneOperation excludedPath(Pattern... patterns)

Excludes source paths from analysis (-XepExcludedPaths:regex).

Values are joined with |.

Any pattern with non-zero flags is rejected. Note that Pattern.flags() only reports flags passed to Pattern.compile(String, int); inline flags such as (?i) are not included and therefore pass through unrejected. Use a String overload for inline-flag semantics.

Parameters:

patterns - the patterns

Returns:

this operation

Throws:

NullPointerException - if patterns is null or contains null

IllegalArgumentException - if patterns is empty, any element was compiled with explicit flags (non-zero flags()), or any pattern string is blank or contains whitespace or control characters

See Also:

• excludedPath(String...)
• excludedPath(Collection)

flag

public ErrorProneOperation flag(String... flags)

Adds raw Error Prone flags.

Emitted in call order with the per-check methods.

Parameters:

flags - the flags

Returns:

this operation

Throws:

NullPointerException - if flags is null or contains null

IllegalArgumentException - if flags is empty, or any flag is blank or contains whitespace or control characters

fromProject

public ErrorProneOperation fromProject(BaseProject project)

Configures the operation from a project.

Copies the project's verbose setting; a later verbose(...) call overrides it.

Parameters:

project - the project

Returns:

this operation

Throws:

NullPointerException - if project is null

ignoreUnknownCheckNames

public ErrorProneOperation ignoreUnknownCheckNames(boolean ignoreUnknownCheckNames)

Allows unknown check names instead of failing (-XepIgnoreUnknownCheckNames).

Parameters:

ignoreUnknownCheckNames - true to ignore

Returns:

this operation

option

public ErrorProneOperation option(String name)

Sets a check option (-XepOpt:name).

A bare name is equivalent to =true.

Parameters:

name - the option name, optionally namespaced

Returns:

this operation

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is blank or contains whitespace or control characters

option

public ErrorProneOperation option(String name,
 String value)

Sets a check option (-XepOpt:name=value).

Parameters:

name - the option name, optionally namespaced

value - the option value

Returns:

this operation

Throws:

NullPointerException - if name or value is null

IllegalArgumentException - if name or value is blank or contains whitespace or control characters

patchChecks

public ErrorProneOperation patchChecks(Collection<String> checks)

Sets the checks whose suggested fixes are written as a patch (-XepPatchChecks:).

Requires patchLocation(String).

Parameters:

checks - the check names

Returns:

this operation

Throws:

NullPointerException - if checks is null or contains null

IllegalArgumentException - if checks is empty, or any name is blank or contains whitespace or control characters

See Also:

• patchChecks(String...)
• patchLocation(String)

patchChecks

public ErrorProneOperation patchChecks(String... checks)

Sets the checks whose suggested fixes are written as a patch (-XepPatchChecks:).

Requires patchLocation(String).

Parameters:

checks - the check names

Returns:

this operation

Throws:

NullPointerException - if checks is null or contains null

IllegalArgumentException - if checks is empty, or any name is blank or contains whitespace or control characters

See Also:

• patchChecks(Collection)
• patchLocation(String)

patchLocation

public ErrorProneOperation patchLocation(String location)

Sets where patches are written (-XepPatchLocation:).

Parameters:

location - IN_PLACE or a directory

Returns:

this operation

Throws:

NullPointerException - if location is null

IllegalArgumentException - if location is blank or contains whitespace or control characters

See Also:

• patchChecks(String...)
• patchChecks(Collection)

repositories

public ErrorProneOperation repositories(Collection<Repository> repositories)

Sets the repositories to download Error Prone from, replacing the current list.

Default is Repository.MAVEN_CENTRAL.

Parameters:

repositories - the repositories

Returns:

this operation

Throws:

NullPointerException - if repositories is null or contains null

IllegalArgumentException - if repositories is empty

See Also:

• repositories(Repository...)

repositories

public ErrorProneOperation repositories(Repository... repositories)

Sets the repositories to download Error Prone from, replacing the current list.

Default is Repository.MAVEN_CENTRAL.

Parameters:

repositories - the repositories

Returns:

this operation

Throws:

NullPointerException - if repositories is null or contains null

IllegalArgumentException - if repositories is empty

See Also:

• repositories(Collection)

version

public ErrorProneOperation version(Version version)

Sets the Error Prone version.

Default is ERROR_PRONE_VERSION on JDK 21+ and 2.42.0 on JDK 17-20.

Parameters:

version - the version

Returns:

this operation

Throws:

NullPointerException - if version is null

See Also:

• version(String)
• version()

version

public ErrorProneOperation version(String version)

Sets the Error Prone version.

Default is ERROR_PRONE_VERSION on JDK 21+ and 2.42.0 on JDK 17-20.

Parameters:

version - the version string

Returns:

this operation

Throws:

NullPointerException - if version is null

IllegalArgumentException - if version is blank or not a valid version

See Also:

• version(Version)
• version()

version

public Version version()

Returns the Error Prone version.

Returns:

the version

See Also:

• version(Version)
• version(String)

warnCheck

public ErrorProneOperation warnCheck(Collection<String> names)

Sets Error Prone checks to report at warning severity (-Xep:Check:WARN).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• warnCheck(String...)

warnCheck

public ErrorProneOperation warnCheck(String... names)

Sets Error Prone checks to report at warning severity (-Xep:Check:WARN).

Later calls for the same name win.

Parameters:

names - the check names

Returns:

this operation

Throws:

NullPointerException - if names is null or contains null

IllegalArgumentException - if names is empty, or any name is blank or contains whitespace or control characters

See Also:

• warnCheck(Collection)