Package com.google.errorprone.bugpatterns

Checks added to the java compiler which detect common bug patterns.

Interface Summary

Interface	Description
AbstractMockChecker.MockForbidder	A policy for determining what classes should not be mocked.
AbstractMockChecker.TypeExtractor<T extends com.sun.source.tree.Tree>	An extension of Matcher to return, not just a boolean `matches`, but also extract some type information about the Tree of interest.
BugChecker.AnnotatedTypeTreeMatcher
BugChecker.AnnotationTreeMatcher
BugChecker.ArrayAccessTreeMatcher
BugChecker.ArrayTypeTreeMatcher
BugChecker.AssertTreeMatcher
BugChecker.AssignmentTreeMatcher
BugChecker.BinaryTreeMatcher
BugChecker.BlockTreeMatcher
BugChecker.BreakTreeMatcher
BugChecker.CaseTreeMatcher
BugChecker.CatchTreeMatcher
BugChecker.ClassTreeMatcher
BugChecker.CompilationUnitTreeMatcher
BugChecker.CompoundAssignmentTreeMatcher
BugChecker.ConditionalExpressionTreeMatcher
BugChecker.ContinueTreeMatcher
BugChecker.DoWhileLoopTreeMatcher
BugChecker.EmptyStatementTreeMatcher
BugChecker.EnhancedForLoopTreeMatcher
BugChecker.ExpressionStatementTreeMatcher
BugChecker.ForLoopTreeMatcher
BugChecker.IdentifierTreeMatcher
BugChecker.IfTreeMatcher
BugChecker.ImportTreeMatcher
BugChecker.InstanceOfTreeMatcher
BugChecker.IntersectionTypeTreeMatcher
BugChecker.LabeledStatementTreeMatcher
BugChecker.LambdaExpressionTreeMatcher
BugChecker.LiteralTreeMatcher
BugChecker.MemberReferenceTreeMatcher
BugChecker.MemberSelectTreeMatcher
BugChecker.MethodInvocationTreeMatcher
BugChecker.MethodTreeMatcher
BugChecker.ModifiersTreeMatcher
BugChecker.NewArrayTreeMatcher
BugChecker.NewClassTreeMatcher
BugChecker.ParameterizedTypeTreeMatcher
BugChecker.ParenthesizedTreeMatcher
BugChecker.PrimitiveTypeTreeMatcher
BugChecker.ReturnTreeMatcher
BugChecker.SwitchTreeMatcher
BugChecker.SynchronizedTreeMatcher
BugChecker.ThrowTreeMatcher
BugChecker.TryTreeMatcher
BugChecker.TypeCastTreeMatcher
BugChecker.TypeParameterTreeMatcher
BugChecker.UnaryTreeMatcher
BugChecker.UnionTypeTreeMatcher
BugChecker.VariableTreeMatcher
BugChecker.WhileLoopTreeMatcher
BugChecker.WildcardTreeMatcher

Class Summary

Class	Description
AbstractAsKeyOfSetOrMap	Check for usage of Set<T> or Map<T, E>.
AbstractMockChecker<T extends Annotation>	Helper for enforcing Annotations that disallow mocking.
AbstractMockChecker.Reason	An explanation of what type should not be mocked, and the reason why.
AbstractMustBeClosedChecker	An abstract check for resources that must be closed; used by StreamResourceLeak and MustBeClosedChecker.
AbstractMustBeClosedChecker.Change	Error Prone's fix application logic doesn't like it when a fix suggests multiple identical insertions at the same position.
AbstractPatternSyntaxChecker	Finds calls to regex-accepting methods with literal strings.
AbstractReferenceEquality	Abstract implementation of a BugPattern that detects the use of reference equality to compare classes with value semantics.
AbstractReturnValueIgnored	An abstract base class to match API usages in which the return value is not used.
AbstractToString	An abstract matcher for implicit and explicit calls to Object.toString(), for use on types that do not have a human-readable toString() implementation.
AbstractUseSwitch	Helper for refactoring from if-else chains to switches.
AlreadyChecked	Bugpattern to find conditions which are checked more than once.
AlwaysThrows	A BugChecker; see the associated BugPattern annotation for details.
AmbiguousMethodReference	A BugChecker; see the associated BugPattern annotation for details.
AnnotateFormatMethod	Detects occurrences of pairs of parameters being passed straight through to String.format(java.lang.String, java.lang.Object...) from a method not annotated with FormatMethod.
AnnotationMirrorToString	A BugChecker; see the associated BugPattern annotation for details.
AnnotationPosition	Checks annotation positioning, and orphaned Javadocs.
AnnotationValueToString	A BugChecker; see the associated BugPattern annotation for details.
ArrayAsKeyOfSetOrMap	Warns that users should not have an array as a key to a Set or Map
ArrayEquals
ArrayFillIncompatibleType	Checks when Arrays.fill(Object[], Object) is called with object types that are guaranteed to result in an ArrayStoreException.
ArrayHashCode
ArraysAsListPrimitiveArray
ArrayToString
AssertFalse
AssertionFailureIgnored	A BugChecker; see the associated BugPattern annotation for details.
AssertThrowsMultipleStatements	A BugChecker; see the associated BugPattern annotation for details.
AssertThrowsUtils	Utility methods for refactoring try-fail pattern to assertThrows, which is preferred.
ASTHelpersSuggestions	A BugPattern; see the summary
AsyncCallableReturnsNull	Checks that AsyncCallable implementations do not directly return null.
AsyncFunctionReturnsNull	Checks that AsyncFunction implementations do not directly return null.
AutoValueBuilderDefaultsInConstructor	See summary for details.
AutoValueFinalMethods	Checks the toString(), hashCode() and equals() methods are final in AutoValue classes.
AutoValueImmutableFields	Flags mutable collections in AutoValue.
AutoValueSubclassLeaked	Matches AutoValue_ uses outside the containing file.
AvoidObjectArrays	A BugChecker; see the associated BugPattern annotation for details.
BadAnnotationImplementation	Checker that ensures implementations of Annotation override equals and hashCode.
BadComparable
BadImport
BadInstanceof	Matches instanceof checks where the expression is a subtype of the checked type.
BadShiftAmount
BanJNDI	A BugChecker that detects use of the unsafe JNDI API system.
BanSerializableRead	A BugChecker that detects use of the unsafe Serializable API.
BareDotMetacharacter	A BugChecker; see the associated BugPattern for details.
BigDecimalEquals	Matches use of BigDecimal#equals, which compares scale as well (which is not likely to be intended).
BigDecimalLiteralDouble	Matches usages of new BigDecimal(double) which lose precision.
BooleanParameter	A BugChecker; see the associated BugPattern annotation for details.
BoxedPrimitiveConstructor	A BugChecker; see the associated BugPattern annotation for details.
BoxedPrimitiveEquality	A BugChecker; see the associated BugPattern annotation for details.
BugChecker	A base class for implementing bug checkers.
BugPatternNaming	See the summary.
ByteBufferBackingArray	Checks when ByteBuffer.array() is used without calling .arrayOffset() to know the offset of the array, or when the buffer wasn't initialized using ByteBuffer.wrap() or ByteBuffer.allocate().
CacheLoaderNull	A BugChecker; see the associated BugPattern annotation for details.
CanBeStaticAnalyzer	Analyzes trees for references to their enclosing instance.
CanBeStaticAnalyzer.CanBeStaticResult	Stores the result of a can-be-static query.
CannotMockFinalClass	Bug pattern to recognize attempts to mock final types.
CannotMockMethod	A BugPattern; see the summary
CanonicalDuration	A BugChecker; see the associated BugPattern annotation for details.
CatchAndPrintStackTrace	A BugChecker; see the associated BugPattern annotation for details.
CatchFail	A BugChecker; see the associated BugPattern annotation for details.
CatchingUnchecked	Flags code which catches RuntimeExceptions under the guise of catching Exception.
ChainedAssertionLosesContext	Identifies calls to assertThat and similar methods inside the implementation of a Subject assertion method.
ChainingConstructorIgnoresParameter	Checks, if two constructors in a class both accept Foo foo and one calls the other, that the caller passes foo as a parameter.
CharacterGetNumericValue	Checks for use of Character.getNumericValue and UCharacter.getNumericValue
CheckedExceptionNotThrown	Flags checked exceptions which are claimed to be thrown, but are not.
CheckNotNullMultipleTimes	Checks for the same variable being checked against null twice in a method.
CheckReturnValue
ClassCanBeStatic
ClassName	A BugChecker; see the associated BugPattern annotation for details.
ClassNamedLikeTypeParameter
ClassNewInstance	A BugChecker; see the associated BugPattern annotation for details.
CollectionToArraySafeParameter
CollectorShouldNotUseState
ComparableAndComparator
ComparableType
CompareToZero	Suggests comparing the result of compareTo to only 0.
ComparingThisWithNull	Check for expressions containing this != null or this == null
ComparisonContractViolated
ComparisonOutOfRange	A BugChecker; see the associated BugPattern annotation for details.
CompileTimeConstantChecker	A Bugpattern; see the accompanying Markdown documentation.
ComplexBooleanConstant
ComputeIfAbsentAmbiguousReference	Flags ambiguous creations of objects in Map.computeIfAbsent(K, java.util.function.Function<? super K, ? extends V>).
ConditionalExpressionNumericPromotion
ConstantField	A BugChecker; see the associated BugPattern annotation for details.
ConstantOverflow	A BugChecker; see the associated BugPattern annotation for details.
ConstantPatternCompile	Flags variables initialized with Pattern.compile(String) calls that could be constants.
DangerousLiteralNullChecker	A BugChecker; see the associated BugPattern annotation for details.
DateFormatConstant	A BugChecker; see the associated BugPattern annotation for details.
DeadException
DeadThread	A BugChecker; see the associated BugPattern annotation for details.
DeduplicateConstants	A checker that suggests deduplicating literals with existing constant variables.
DefaultCharset	A BugChecker; see the associated BugPattern annotation for details.
DefaultPackage	Java classes shouldn't use default package.
DepAnn	Matches the behaviour of the javac dep-ann Xlint warning.
DeprecatedVariable	A BugChecker; see the associated BugPattern annotation for details.
DifferentNameButSame	Discourages using multiple names to refer to the same type within a file (e.g.
DirectInvocationOnMock	A bugpattern; see the description.
DiscardedPostfixExpression	A BugChecker; see the associated BugPattern annotation for details.
DistinctVarargsChecker	ErrorProne checker to generate warning when method expecting distinct varargs is invoked with same variable argument.
DoNotCallChecker	A BugChecker; see the associated BugPattern annotation for details.
DoNotCallSuggester	If a method always throws an exception, consider annotating it with @DoNotCall to prevent calls at compile-time instead failing at runtime.
DoNotClaimAnnotations	A BugChecker; see the associated BugPattern annotation for details.
DoNotMockAutoValue	Suggests not mocking AutoValue classes.
DoNotMockChecker	Points out if a Mockito or EasyMock mock is mocking an object that would be better off being tested using an alternative instance.
DoubleBraceInitialization	A BugChecker; see the associated BugPattern annotation for details.
DuplicateMapKeys	Flags duplicate keys used in ImmutableMap construction.
EmptyCatch	A BugChecker; see the associated BugPattern annotation for details.
EmptyIfStatement	This checker finds and fixes empty statements after an if, with no else part.
EmptyTopLevelDeclaration	A BugChecker; see the associated BugPattern annotation for details.
EqualsGetClass	Discourages the use of Object.getClass() when implementing Object.equals(Object) for non-final classes.
EqualsHashCode	Classes that override Object.equals(java.lang.Object) should also override Object.hashCode().
EqualsIncompatibleType
EqualsNaN
EqualsNull	A BugChecker; see the associated BugPattern annotation for details.
EqualsReference
EqualsUnsafeCast	Checks for equals implementations making unsafe casts.
EqualsUsingHashCode	Discourages implementing equals using hashCode.
EqualsWrongThing	Checks for equals implementations comparing non-corresponding fields.
ErroneousBitwiseExpression	A BugPattern; see the summary.
ErroneousThreadPoolConstructorChecker	ErrorProne checker to generate warning whenever ThreadPoolExecutor is constructed with different corePoolSize and maximumPoolSize using an unbounded workQueue
ExpectedExceptionChecker	A BugChecker; see the associated BugPattern annotation for details.
ExtendingJUnitAssert
ExtendsAutoValue	Makes sure that you are not extending a class that has @AutoValue as an annotation.
FallThrough	A BugChecker; see the associated BugPattern annotation for details.
FieldCanBeFinal
FieldCanBeLocal	Flags fields which can be replaced with local variables.
FieldCanBeStatic	Finds fields which can be safely made static.
Finalize	A BugChecker; see the associated BugPattern annotation for details.
Finally	Matches the behaviour of javac's finally Xlint warning.
FloatCast	A BugChecker; see the associated BugPattern annotation for details.
FloatingPointAssertionWithinEpsilon	Detects usages of Float,DoubleSubject.isWithin(TOLERANCE).of(EXPECTED) where there are no other floating point values other than EXPECTED with satisfy the assertion, but TOLERANCE is not zero.
FloatingPointLiteralPrecision	A BugChecker; see the associated BugPattern annotation for details.
ForEachIterable	A BugChecker; see the associated BugPattern annotation for details.
ForOverrideChecker	Verifies that methods marked ForOverride are only called from the defining class.
FunctionalInterfaceClash	A BugChecker; see the associated BugPattern annotation for details.
FunctionalInterfaceMethodChanged
FutureReturnValueIgnored	See BugPattern annotation.
FuturesGetCheckedIllegalExceptionType	Checks for calls to Guava's Futures.getChecked method that will always fail because they pass an incompatible exception type.
FuzzyEqualsShouldNotBeUsedInEqualsMethod
GetClassOnAnnotation	A BugChecker; see the associated BugPattern annotation for details.
GetClassOnClass
GetClassOnEnum	A BugChecker; see the associated BugPattern annotation for details.
HashtableContains	A BugChecker; see the associated BugPattern annotation for details.
HidingField
IdentityBinaryExpression	A BugChecker; see the associated BugPattern annotation for details.
IdentityHashMapBoxing	A BugChecker; see the associated BugPattern annotation for details.
IdentityHashMapUsage	A BugChecker; see the associated BugPattern annotation for details.
IgnoredPureGetter	Flags ignored return values from pure getters.
ImmutableCollections	Common utility functions for immutable collections.
ImmutableMemberCollection	Refactoring to suggest Immutable types for member collection that are not mutated.
ImmutableSetForContains	Refactoring to suggest using private static final ImmutableSet over ImmutableList when using only contains, containsAll and isEmpty.
ImplementAssertionWithChaining	Migrates Truth subjects from a manual "test and fail" approach to one using Subject.check(...).
ImpossibleNullComparison	Matches comparison of proto fields to null.
Incomparable	A BugChecker; see the associated BugPattern annotation for details.
IncompatibleModifiersChecker
InconsistentCapitalization	Checker for variables under the same scope that only differ in capitalization.
InconsistentHashCode	Looks for hashCode implementations which are inconsistent with equals.
IncorrectMainMethod	Bugpattern for incorrect overloads of main.
IncrementInForLoopAndHeader
IndexOfChar	A BugChecker; see the associated BugPattern annotation for details.
InexactVarargsConditional	A BugChecker; see the associated BugPattern annotation for details.
InfiniteRecursion	A BugChecker; see the associated BugPattern annotation for details.
InitializeInline	Bugpattern to encourage initializing effectively final variables inline with their declaration, if possible.
InjectOnBugCheckers	A BugPattern; see the summary.
InputStreamSlowMultibyteRead	Checks that InputStreams should override int read(byte[], int, int);
InsecureCipherMode
InstanceOfAndCastMatchWrongType
InterfaceWithOnlyStatics	Bugpattern to detect interfaces used only to store static fields/methods.
InterruptedExceptionSwallowed	Checks for cases where an InterruptedException is caught as part of a catch block catching a supertype, and not specially handled.
Interruption	A BugChecker; see the associated BugPattern annotation for details.
IntLongMath	A BugChecker; see the associated BugPattern annotation for details.
InvalidPatternSyntax
InvalidTimeZoneID
InvalidZoneId	Validates ZoneId.
IsInstanceIncompatibleType
IsInstanceOfClass	A BugChecker; see the associated BugPattern annotation for details.
IterableAndIterator
IterablePathParameter	A BugChecker; see the associated BugPattern annotation for details.
JavaLangClash	A BugChecker; see the associated BugPattern annotation for details.
JavaUtilDateChecker	A BugChecker; see the associated BugPattern annotation for details.
JdkObsolete	A BugChecker; see the associated BugPattern annotation for details.
JUnit3FloatingPointComparisonWithoutDelta	Detects floating-point assertEquals() calls that will not work in JUnit 4.
JUnit3TestNotRun	A bugpattern; see the associated summary.
JUnit4ClassAnnotationNonStatic	@BeforeClass or @AfterClass should be applied to static methods.
JUnit4ClassUsedInJUnit3
JUnit4SetUpNotRun	Checks for the existence of a JUnit3 style setUp() method in a JUnit4 test class or methods annotated with a non-JUnit4 @Before annotation.
JUnit4TearDownNotRun	Checks for the existence of a JUnit3 style tearDown() method in a JUnit4 test class or methods annotated with a non-JUnit4 @After annotation.
JUnit4TestNotRun
JUnit4TestsNotRunWithinEnclosed	Finds tests that won't run due to the enclosing runner.
JUnitAmbiguousTestClass
JUnitAssertSameCheck	Points out if an object is tested for reference equality to itself using JUnit library.
JUnitParameterMethodNotFound	Checks if the methods specified in junitparams.Parameters annotation to provide parameters exists.
LabelledBreakTarget	A BugPattern; see the summary.
LambdaFunctionalInterface
LenientFormatStringValidation	A BugPattern; see the summary.
LiteByteStringUtf8
LiteEnumValueOf	Points out if #valueOf() is called on a Protocol Buffer Enum.
LiteProtoToString	Flags calls to toString on lite protos.
LockNotBeforeTry	Suggests that calls to Lock.lock must be immediately followed by a try-finally that calls Lock.unlock.
LockOnBoxedPrimitive	Detects locks on boxed primitives.
LogicalAssignment	A BugChecker; see the associated BugPattern annotation for details.
LongDoubleConversion	A BugChecker; see the associated BugPattern annotation for details.
LongFloatConversion	A BugChecker; see the associated BugPattern annotation for details.
LongLiteralLowerCaseSuffix	Matcher for a long literal with a lower-case ell for a suffix (e.g.
LoopConditionChecker	A BugChecker; see the associated BugPattern annotation for details.
LoopOverCharArray	A BugChecker; see the associated BugPattern annotation for details.
LossyPrimitiveCompare	Checker to prevent usages of comparison methods where both the operands undergo lossy widening.
MathAbsoluteNegative
MathRoundIntLong	Check for calls to Math's Math.round(float) with an integer or long parameter.
MemberName	Flags a few ways in which member names may violate the style guide.
MemoizeConstantVisitorStateLookups	A BugChecker; see the associated BugPattern annotation for details.
MethodCanBeStatic	A BugChecker; see the associated BugPattern annotation for details.
MissingBraces	A BugChecker; see the associated BugPattern annotation for details.
MissingCasesInEnumSwitch	A BugChecker; see the associated BugPattern annotation for details.
MissingDefault	A BugChecker; see the associated BugPattern annotation for details.
MissingFail
MissingImplementsComparable	A BugChecker; see the associated BugPattern annotation for details.
MissingOverride	A BugChecker; see the associated BugPattern annotation for details.
MissingSuperCall
MissingTestCall	Matches test helpers which require a terminating method to be called.
MisusedDateFormat	Base class for checks which find common errors in date format patterns.
MisusedDayOfYear	Ban use of D (day-of-year) in a date format pattern that also contains M (month-of-year).
MisusedWeekYear	Ban use of YYYY in a SimpleDateFormat pattern, unless it is being used for a week date.
MixedArrayDimensions	A BugChecker; see the associated BugPattern annotation for details.
MixedDescriptors	Checks for calls to Descriptor#findFieldByNumber with field numbers from a different proto.
MixedMutabilityReturnType	Flags methods which return mutable collections from some code paths, but immutable ones from others.
MockitoUsage	A BugChecker; see the associated BugPattern annotation for details.
MockNotUsedInProduction	A BugPattern; see the summary.
ModifiedButNotUsed	Matches creation of new collections/proto builders which are modified but never used.
ModifyCollectionInEnhancedForLoop
ModifyingCollectionWithItself
ModifySourceCollectionInStream	Identify the backing collection source of a stream and reports if the source is mutated during the stream operations.
MultipleParallelOrSequentialCalls
MultipleTopLevelClasses	A BugChecker; see the associated BugPattern annotation for details.
MultipleUnaryOperatorsInMethodCall
MultiVariableDeclaration	A BugChecker; see the associated BugPattern annotation for details.
MustBeClosedChecker	Checks if a constructor or method annotated with MustBeClosed is called within the resource variable initializer of a try-with-resources statement.
MutablePublicArray	Check for public static final declaration of Arrays.
NarrowCalculation	A BugPattern; see the summary.
NarrowingCompoundAssignment	A BugChecker; see the associated BugPattern annotation for details.
NCopiesOfChar	A BugChecker; see the associated BugPattern annotation for details.
NegativeCharLiteral	A BugChecker; see the associated BugPattern annotation for details.
NestedInstanceOfConditions
NewFileSystem	A BugChecker; see the associated BugPattern annotation for details.
NoAllocationChecker	Checks methods annotated with @NoAllocation to ensure they really do not allocate.
NonAtomicVolatileUpdate	Detects non-atomic updates to volatile variables.
NonCanonicalStaticImport	Types shouldn't be statically by their non-canonical name.
NonCanonicalStaticMemberImport	Members shouldn't be statically imported by their non-canonical name.
NonCanonicalType	Flags types being referred to by their non-canonical name.
NonFinalCompileTimeConstant	Enforce that @CompileTimeConstant parameters are final or effectively final.
NonOverridingEquals	Bug checker for equals methods that don't actually override equals.
NonRuntimeAnnotation
NullableConstructor	A BugChecker; see the associated BugPattern annotation for details.
NullableOnContainingClass	A bugpattern; see the summary.
NullablePrimitive
NullablePrimitiveArray	A BugChecker; see the associated BugPattern annotation for details.
NullableVoid	A BugChecker; see the associated BugPattern annotation for details.
NullOptional	Flags passing literal null to Optional-accepting APIs.
NullTernary	A BugChecker; see the associated BugPattern annotation for details.
ObjectEqualsForPrimitives	Check for usage of Objects.equal on primitive types.
ObjectsHashCodePrimitive	Check for calls to Objects' Objects.hashCode(java.lang.Object) with a primitive parameter.
ObjectToString	Warns against calling toString() on Objects which don't have toString() method overridden and won't produce meaningful output.
OperatorPrecedence	A BugChecker; see the associated BugPattern annotation for details.
OptionalEquality	A BugChecker; see the associated BugPattern annotation for details.
OptionalMapToOptional	Matches Optional#map mapping to another Optional.
OptionalMapUnusedValue	Replaces Optional.map with Optional.ifPresent if the value is unused.
OptionalNotPresent
OptionalOfRedundantMethod	Checks if Optional#of is chained with a redundant method.
OrphanedFormatString	A BugChecker; see the associated BugPattern annotation for details.
OutlineNone	Check for the a11y antipattern of setting CSS outline attributes to none or 0.
Overrides	Matches the behaviour of javac's overrides Xlint warning.
OverrideThrowableToString	Warns against overriding toString() in a Throwable class and suggests getMessage()
PackageInfo	A BugChecker; see the associated BugPattern annotation for details.
PackageLocation	A BugChecker; see the associated BugPattern annotation for details.
ParameterComment	A BugChecker; see the associated BugPattern annotation for details.
ParameterName	A BugChecker; see the associated BugPattern annotation for details.
ParametersButNotParameterized	Flags uses of parameters in non-parameterized tests.
PreconditionsCheckNotNullRepeated	Checks that Precondition.checkNotNull is not invoked with same arg twice.
PreconditionsInvalidPlaceholder
PreferredInterfaceType	Tightens types which refer to an Iterable, Map, Multimap, etc.
PrimitiveArrayPassedToVarargsMethod
PrimitiveAtomicReference	Discourages inadvertently using reference equality on boxed primitives in AtomicReference.
PrivateConstructorForUtilityClass
PrivateSecurityContractProtoAccess	Check for disallowed access to private_do_not_access_or_else proto fields.
ProtectedMembersInFinalClass	Flags protected members in final classes.
ProtoBuilderReturnValueIgnored	Highlights cases where a proto's build method has its return value ignored.
ProtocolBufferOrdinal	Points out if #ordinal() is called on a Protocol Buffer Enum.
ProtoRedundantSet	Checks that protocol buffers built with chained builders don't set the same field twice.
ProtoStringFieldReferenceEquality
ProtoTruthMixedDescriptors	Checks that ProtoTruth's ignoringFields is passed field numbers from the correct proto.
PublicApiNamedStreamShouldReturnStream	Checks if public APIs named "stream" returns a type whose name ends with Stream.
RandomCast	A BugChecker; see the associated BugPattern annotation for details.
RandomModInteger
ReachabilityFenceUsage	A BugChecker; see the associated BugPattern annotation for details.
RedundantOverride	Removes overrides which purely pass through to the method in the super class.
RedundantThrows	A BugChecker; see the associated BugPattern annotation for details.
ReferenceEquality	A BugChecker; see the associated BugPattern annotation for details.
RemoveUnusedImports
ReplacementVariableFinder	Utility methods to find replacement variables with similar names.
RequiredModifiersChecker
RestrictedApiChecker	Check for non-allowlisted callers to RestrictedApiChecker.
RethrowReflectiveOperationExceptionAsLinkageError	A BugChecker; see the associated BugPattern annotation for details.
ReturnsNullCollection	Flags methods with collection return types which return null in some cases but don't annotate the method as @Nullable.
ReturnValueIgnored	A checker which produces an error when a return value is accidentally discarded.
RobolectricShadowDirectlyOn	A BugChecker; see the summary.
RxReturnValueIgnored	A BugChecker; see the associated BugPattern for details.
SameNameButDifferent	Looks for types being shadowed by other types in a way that may be confusing.
SelfAlwaysReturnsThis	A BugChecker; see the associated BugPattern annotation for details.
SelfAssignment	TODO(eaftan): Consider cases where the parent is not a statement or there is no parent?
SelfComparison	Points out if an object is compared to itself.
SelfEquals
SerializableReads	List of banned methods for BanSerializableRead.
ShortCircuitBoolean
ShortCircuitBoolean.TreeScannerBinary	Replaces the operators when visiting the binary nodes
ShouldHaveEvenArgs	Checks that variable argument methods have even number of arguments.
SizeGreaterThanOrEqualsZero	Finds instances where one uses Collection#size() >= 0 or T[].length > 0.
StatementSwitchToExpressionSwitch	Checks for statement switches that can be expressed as an equivalent expression switch.
StaticAssignmentInConstructor	Checks for static fields being assigned within constructors.
StaticAssignmentOfThrowable	Checks for static fields being assigned with Throwable.
StaticImports	Logic for inspecting static imports used by NonCanonicalStaticImport, NonCanonicalStaticMemberImport, and UnnecessaryStaticImport.
StaticImports.StaticImportInfo	Information about a static import.
StaticMockMember	A BugChecker; see the associated BugPattern annotation for details.
StaticQualifiedUsingExpression
StreamResourceLeak	A BugChecker; see the associated BugPattern annotation for details.
StreamToIterable	Discourage stream::iterator to create Iterables.
StreamToString	A BugChecker; see the associated BugPattern annotation for details.
StringBuilderInitWithChar
StringCaseLocaleUsage	A BugChecker that flags calls to String.toLowerCase() and String.toUpperCase(), as these methods implicitly rely on the environment's default locale.
StringSplitter	A BugChecker; see the associated BugPattern annotation for details.
StronglyType	Helper for strongly typing fields.
StronglyType.Builder	Builder for StronglyType
StronglyTypeByteString	Flags fields which would be better expressed as ByteStrings rather than primitive byte arrays.
SubstringOfZero	Check for calls to String's foo.substring(0).
SuppressWarningsDeprecated	Find uses of SuppressWarnings with "deprecated".
SuppressWarningsWithoutExplanation	Finds occurrences of @SuppressWarnings where there is definitely no explanation for why it is safe.
SwigMemoryLeak
SwitchDefault	A BugChecker; see the associated BugPattern annotation for details.
SymbolToString	Flags com.sun.tools.javac.code.Symbol#toString usage in BugCheckers.
SystemExitOutsideMain	Check for calls to System.exit() outside of a main method.
SystemOut	A BugChecker; see the associated BugPattern annotation for details.
TestExceptionChecker	A BugChecker; see the associated BugPattern annotation for details.
TestParametersNotInitialized	Flags uses of parameters in non-parameterized tests.
TheoryButNoTheories	Flags uses of @Theory (and others) in non-Theories-run tests.
ThreadJoinLoop
ThreadLocalUsage	A BugChecker; see the associated BugPattern annotation for details.
ThreeLetterTimeZoneID
ThrowIfUncheckedKnownChecked	Catches no-op calls to Throwables.throwIfUnchecked.
ThrowNull	A BugChecker; see the associated BugPattern annotation for details.
ThrowSpecificExceptions	Bugpattern to discourage throwing base exception classes.
ThrowsUncheckedException	Suggests to remove the unchecked throws clause.
TooManyParameters	A BugChecker; see the associated BugPattern annotation for details.
ToStringReturnsNull	ToString should not return null.
TransientMisuse	Warns against use of both static and transient modifiers on field declarations.
TreeToString	Flags com.sun.source.tree.Tree#toString usage in BugCheckers.
TruthAssertExpected	Detects usages of Truth assertions with the expected and actual values reversed.
TruthConstantAsserts	Points out if Truth Library assert is called on a constant.
TruthGetOrDefault	Flags ambiguous usages of Map#getOrDefault within Truth#assertThat.
TruthSelfEquals	Points out if an object is tested for equality/inequality to itself using Truth Libraries.
TryFailRefactoring	A BugChecker; see the associated BugPattern annotation for details.
TryFailThrowable	A bug checker for the following code pattern:
TryWithResourcesVariable	A BugChecker; see the associated BugPattern annotation for details.
TypeCompatibilityUtils	Logical utility methods to answer the question: Are these two types "compatible" with each other, in the context of an equality check.
TypeCompatibilityUtils.TypeCompatibilityReport
TypeEqualsChecker	Flags com.sun.tools.javac.code.Type#equals usage.
TypeNameShadowing	Warns when a type parameter shadows another type name in scope.
TypeParameterNaming	Enforces type parameters match the google style guide.
TypeParameterQualifier	A BugChecker; see the associated BugPattern annotation for details.
TypeParameterShadowing
TypeParameterUnusedInFormals
TypeToString	Flags com.sun.tools.javac.code.Type#toString usage in BugCheckers.
UndefinedEquals	Flags types which do not have well-defined equals behavior.
UngroupedOverloads
UnicodeDirectionalityCharacters	Bans, without the possibility of suppression, the use of direction-changing Unicode escapes.
UnicodeEscape	Replaces printable ASCII unicode escapes with the literal version.
UnicodeInCode	Bans using non-ASCII Unicode characters outside string literals and comments.
UnnecessarilyFullyQualified	Flags uses of fully qualified names which are not ambiguous if imported.
UnnecessarilyVisible	Suggests restricting the visibility of methods which should only be called by a framework.
UnnecessaryAnonymousClass	A BugChecker; see the associated BugPattern annotation for details.
UnnecessaryAssignment	Discourage manual initialization or assignment to fields annotated with framework annotations.
UnnecessaryBoxedAssignment	Finds and fixes unnecessarily boxed return expressions.
UnnecessaryBoxedVariable	Finds and fixes unnecessarily boxed variables.
UnnecessaryDefaultInEnumSwitch	A BugChecker; see the associated BugPattern annotation for details.
UnnecessaryFinal	Removes final from non-field variables.
UnnecessaryLambda	A BugChecker; see the associated BugPattern annotation for details.
UnnecessaryLongToIntConversion	A BugChecker; see the associated BugPattern annotation for details.
UnnecessaryMethodInvocationMatcher	Matchers.methodInvocation(Matcher) is not exactly deprecated, but it is legacy, and in particular is not needed when the argument is a MethodMatcher, since MethodMatcher already does the unwrapping that methodInvocation does.
UnnecessaryMethodReference	Matches unnecessary uses of method references.
UnnecessaryOptionalGet	A refactoring to replace Optional.get() with lambda arg in expressions passed as arg to member functions of Optionals.
UnnecessaryParentheses	A BugChecker; see the associated BugPattern annotation for details.
UnnecessarySetDefault	A BugChecker; see the associated BugPattern annotation for details.
UnnecessaryStaticImport	A BugChecker; see the associated BugPattern annotation for details.
UnnecessaryTestMethodPrefix	See the summary.
UnnecessaryTypeArgument	A BugChecker; see the associated BugPattern annotation for details.
UnqualifiedYield	A BugChecker; see the associated BugPattern annotation for details.
UnsafeFinalization	A BugChecker; see the associated BugPattern annotation for details.
UnsafeLocaleUsage	Flags unsafe usages of the Locale constructor and class methods.
UnsafeReflectiveConstructionCast	Checks unsafe instance creation via reflection.
UnsynchronizedOverridesSynchronized	A BugChecker; see the associated BugPattern annotation for details.
UnusedAnonymousClass	A BugChecker; see the associated BugPattern annotation for details.
UnusedCollectionModifiedInPlace
UnusedException	Bugpattern for catch blocks which catch an exception but throw another one without wrapping the original.
UnusedLabel	A BugPattern; see the summary.
UnusedMethod	Bugpattern to detect unused declarations.
UnusedNestedClass	Bugpattern to detect unused nested classes.
UnusedTypeParameter	A BugPattern; see the summary.
UnusedVariable	Bugpattern to detect unused declarations.
URLEqualsHashCode	Points out on creation of Set and HashMap of type java.net.URL.
UseCorrectAssertInTests
UseEnumSwitch	A BugChecker; see the associated BugPattern annotation for details.
VarChecker	A BugChecker; see the associated BugPattern annotation for details.
VariableNameSameAsType	Check for variables and types with the same name
Varifier	Converts some local variables to use var.
VarTypeName	A BugChecker; see the associated BugPattern annotation for details.
WaitNotInLoop
WildcardImport	A BugChecker; see the associated BugPattern annotation for details.
WithSignatureDiscouraged	MethodMatchers.MethodClassMatcher.withSignature(String) is discouraged: most usages should use .named and/or .withParameters instead.
WrongOneof	Matches always-default expressions in oneof switches.
XorPower	A BugChecker; see the associated BugPattern annotation for details.
YodaCondition	See the summary.

Enum Summary

Enum	Description
TypeParameterNaming.TypeParameterNamingClassification	An enum that classifies a String name into different types, based on the Google Java Style Guide's rules for Type Parameters.
TypesWithUndefinedEquality	Enumerates types which have poorly-defined behaviour for equals.