Class BugCheckerInfo

java.lang.Object

com.google.errorprone.BugCheckerInfo

All Implemented Interfaces:

Serializable

public class BugCheckerInfo
extends Object
implements Serializable

An accessor for information about a single bug checker, including the metadata in the check's @BugPattern annotation and the class that implements the check.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Set<String>	allNames()
String	canonicalName()
static String	canonicalName(String className, BugPattern pattern)
Class<? extends BugChecker>	checkerClass()
static BugCheckerInfo	create(Class<? extends BugChecker> checker)
Set<Class<? extends Annotation>>	customSuppressionAnnotations()
BugPattern.SeverityLevel	defaultSeverity()
boolean	disableable()
boolean	equals(Object o)
com.google.common.collect.ImmutableSet<String>	getTags()
int	hashCode()
String	linkUrl()
String	message()
BugPattern.SeverityLevel	severity(Map<String,BugPattern.SeverityLevel> severities)
boolean	supportsSuppressWarnings()
String	toString()
BugCheckerInfo	withCustomDefaultSeverity(BugPattern.SeverityLevel defaultSeverity)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

create

public static BugCheckerInfo create(Class<? extends BugChecker> checker)

withCustomDefaultSeverity

public BugCheckerInfo withCustomDefaultSeverity(BugPattern.SeverityLevel defaultSeverity)

Returns:

a BugCheckerInfo with the same information as this class, except that its default severity is the passed in parameter. If this checker's current defaultSeverity is the same as the argument, return this.

canonicalName

public String canonicalName()

canonicalName

public static String canonicalName(String className,
 BugPattern pattern)

allNames

public Set<String> allNames()

message

public String message()

defaultSeverity

public BugPattern.SeverityLevel defaultSeverity()

severity

public BugPattern.SeverityLevel severity(Map<String,BugPattern.SeverityLevel> severities)

linkUrl

public String linkUrl()

supportsSuppressWarnings

public boolean supportsSuppressWarnings()

customSuppressionAnnotations

public Set<Class<? extends Annotation>> customSuppressionAnnotations()

disableable

public boolean disableable()

getTags

public com.google.common.collect.ImmutableSet<String> getTags()

checkerClass

public Class<? extends BugChecker> checkerClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object