Class ScannerSupplier

java.lang.Object

com.google.errorprone.scanner.ScannerSupplier

All Implemented Interfaces:

com.google.common.base.Supplier<Scanner>, Supplier<Scanner>

public abstract class ScannerSupplier
extends Object
implements com.google.common.base.Supplier<Scanner>

Supplies Scanners and provides access to the backing sets of all BugCheckers and enabled BugCheckers.

Constructor Summary

Constructors

Constructor	Description
ScannerSupplier()

Method Summary

Modifier and Type	Method	Description
ScannerSupplier	applyOverrides(ErrorProneOptions errorProneOptions)	Applies options to this ScannerSupplier.
protected abstract com.google.common.collect.ImmutableSet<String>	disabled()
protected Set<String>	enabled()
ScannerSupplier	filter(com.google.common.base.Predicate<? super BugCheckerInfo> predicate)	Filters this ScannerSupplier based on the provided predicate.
static ScannerSupplier	fromBugCheckerClasses(Class<? extends BugChecker>... checkerClasses)	Returns a ScannerSupplier with a specific list of BugChecker classes.
static ScannerSupplier	fromBugCheckerClasses(Iterable<Class<? extends BugChecker>> checkers)	Returns a ScannerSupplier with a specific list of BugChecker classes.
static ScannerSupplier	fromBugCheckerInfos(Iterable<BugCheckerInfo> checkers)	Returns a ScannerSupplier built from a list of BugCheckerInfos.
static ScannerSupplier	fromScanner(Scanner scanner)	Returns a ScannerSupplier that just returns the Scanner that was passed in.
abstract com.google.common.collect.ImmutableBiMap<String,BugCheckerInfo>	getAllChecks()	Returns a map of check name to BugCheckerInfo for all BugCheckerInfos in this ScannerSupplier, including disabled ones.
abstract com.google.common.collect.ImmutableSet<BugCheckerInfo>	getEnabledChecks()	Returns the set of BugCheckerInfos that are enabled in this ScannerSupplier.
abstract ErrorProneFlags	getFlags()
ScannerSupplier	plus(ScannerSupplier other)	Composes this ScannerSupplier with the other ScannerSupplier.
abstract com.google.common.collect.ImmutableMap<String,BugPattern.SeverityLevel>	severities()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Supplier

get

Constructor Details

ScannerSupplier

public ScannerSupplier()

Method Details

fromBugCheckerClasses

@SafeVarargs
public static ScannerSupplier fromBugCheckerClasses(Class<? extends BugChecker>... checkerClasses)

Returns a ScannerSupplier with a specific list of BugChecker classes.

fromBugCheckerClasses

public static ScannerSupplier fromBugCheckerClasses(Iterable<Class<? extends BugChecker>> checkers)

Returns a ScannerSupplier with a specific list of BugChecker classes.

fromBugCheckerInfos

public static ScannerSupplier fromBugCheckerInfos(Iterable<BugCheckerInfo> checkers)

Returns a ScannerSupplier built from a list of BugCheckerInfos.

fromScanner

public static ScannerSupplier fromScanner(Scanner scanner)

Returns a ScannerSupplier that just returns the Scanner that was passed in. Used mostly for testing. Does not implement any method other than Supplier.get().

getAllChecks

public abstract com.google.common.collect.ImmutableBiMap<String,BugCheckerInfo> getAllChecks()

Returns a map of check name to BugCheckerInfo for all BugCheckerInfos in this ScannerSupplier, including disabled ones.

getEnabledChecks

public abstract com.google.common.collect.ImmutableSet<BugCheckerInfo> getEnabledChecks()

Returns the set of BugCheckerInfos that are enabled in this ScannerSupplier.

severities

public abstract com.google.common.collect.ImmutableMap<String,BugPattern.SeverityLevel> severities()

disabled

protected abstract com.google.common.collect.ImmutableSet<String> disabled()

enabled

protected Set<String> enabled()

getFlags

public abstract ErrorProneFlags getFlags()

applyOverrides

@CheckReturnValue
public ScannerSupplier applyOverrides(ErrorProneOptions errorProneOptions)

Applies options to this ScannerSupplier.

Command-line options to override check severities may do any of the following:

• Enable a check that is currently off
• Disable a check that is currently on
• Change the severity of a check that is on, promoting a warning to an error or demoting an error to a warning

Parameters:

errorProneOptions - an ErrorProneOptions object that encapsulates the overrides for this compilation

Throws:

InvalidCommandLineOptionException - if the override map attempts to disable a check that may not be disabled

plus

@CheckReturnValue
public ScannerSupplier plus(ScannerSupplier other)

Composes this ScannerSupplier with the other ScannerSupplier. The set of checks that are turned on is the intersection of the checks on in this and other.

filter

@CheckReturnValue
public ScannerSupplier filter(com.google.common.base.Predicate<? super BugCheckerInfo> predicate)

Filters this ScannerSupplier based on the provided predicate. Returns a ScannerSupplier with only the checks enabled that satisfy the predicate.