Package com.google.errorprone.bugpatterns

Class NoAllocationChecker

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.NoAllocationChecker

All Implemented Interfaces:

BugChecker.AssignmentTreeMatcher, BugChecker.BinaryTreeMatcher, BugChecker.CompoundAssignmentTreeMatcher, BugChecker.EnhancedForLoopTreeMatcher, BugChecker.MethodInvocationTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.NewArrayTreeMatcher, BugChecker.NewClassTreeMatcher, BugChecker.ReturnTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.VariableTreeMatcher, Suppressible, Serializable

public class NoAllocationChecker
extends BugChecker
implements BugChecker.AssignmentTreeMatcher, BugChecker.BinaryTreeMatcher, BugChecker.CompoundAssignmentTreeMatcher, BugChecker.EnhancedForLoopTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.MethodInvocationTreeMatcher, BugChecker.NewArrayTreeMatcher, BugChecker.NewClassTreeMatcher, BugChecker.ReturnTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.VariableTreeMatcher

Checks methods annotated with @NoAllocation to ensure they really do not allocate.

1. Calls to new are disallowed.
2. Methods statically determined to be reachable from this method must also be annotated with @NoAllocation.
3. Autoboxing is disallowed.
4. String concatenation and conversions are disallowed.
5. To make it easier to use exceptions, allocations are always allowed within a throw statement. (But not in the methods of nested classes if they are annotated with NoAllocation.)
6. The check is done at the source level. The compiler or runtime may perform optimizations or transformations that add or remove allocations in a way not visible to this check.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.errorprone.bugpatterns.BugChecker

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.SuppressibleTreePathScanner<A extends Object,B extends Object>, BugChecker.SwitchTreeMatcher, BugChecker.SynchronizedTreeMatcher, BugChecker.ThrowTreeMatcher, BugChecker.TryTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.TypeParameterTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.UnionTypeTreeMatcher, BugChecker.VariableTreeMatcher, BugChecker.WhileLoopTreeMatcher, BugChecker.WildcardTreeMatcher

Constructor Summary

Constructors

Constructor	Description
NoAllocationChecker()

Method Summary

Modifier and Type	Method	Description
Description	matchAssignment(com.sun.source.tree.AssignmentTree tree, VisitorState state)
Description	matchBinary(com.sun.source.tree.BinaryTree tree, VisitorState state)
Description	matchCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree tree, VisitorState state)
Description	matchEnhancedForLoop(com.sun.source.tree.EnhancedForLoopTree tree, VisitorState state)
Description	matchMethod(com.sun.source.tree.MethodTree tree, VisitorState state)
Description	matchMethodInvocation(com.sun.source.tree.MethodInvocationTree tree, VisitorState state)
Description	matchNewArray(com.sun.source.tree.NewArrayTree tree, VisitorState state)
Description	matchNewClass(com.sun.source.tree.NewClassTree tree, VisitorState state)
Description	matchReturn(com.sun.source.tree.ReturnTree tree, VisitorState state)
Description	matchTypeCast(com.sun.source.tree.TypeCastTree tree, VisitorState state)
Description	matchUnary(com.sun.source.tree.UnaryTree tree, VisitorState state)
Description	matchVariable(com.sun.source.tree.VariableTree tree, VisitorState state)

Methods inherited from class com.google.errorprone.bugpatterns.BugChecker

allNames, buildDescription, buildDescription, buildDescription, canonicalName, customSuppressionAnnotations, defaultSeverity, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, disableable, equals, hashCode, isSuppressed, isSuppressed, isSuppressed, isSuppressed, linkUrl, message, supportsSuppressWarnings, suppressedByAnyOf, suppressedRegions

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.errorprone.matchers.Suppressible

allNames, canonicalName, customSuppressionAnnotations, supportsSuppressWarnings, suppressedByAnyOf

Constructor Detail

NoAllocationChecker

public NoAllocationChecker()

Method Detail

matchNewArray

public Description matchNewArray(com.sun.source.tree.NewArrayTree tree,
                                 VisitorState state)

Specified by:

matchNewArray in interface BugChecker.NewArrayTreeMatcher

matchNewClass

public Description matchNewClass(com.sun.source.tree.NewClassTree tree,
                                 VisitorState state)

Specified by:

matchNewClass in interface BugChecker.NewClassTreeMatcher

matchMethodInvocation

public Description matchMethodInvocation(com.sun.source.tree.MethodInvocationTree tree,
                                         VisitorState state)

Specified by:

matchMethodInvocation in interface BugChecker.MethodInvocationTreeMatcher

matchMethod

public Description matchMethod(com.sun.source.tree.MethodTree tree,
                               VisitorState state)

Specified by:

matchMethod in interface BugChecker.MethodTreeMatcher

matchBinary

public Description matchBinary(com.sun.source.tree.BinaryTree tree,
                               VisitorState state)

Specified by:

matchBinary in interface BugChecker.BinaryTreeMatcher

matchCompoundAssignment

public Description matchCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree tree,
                                           VisitorState state)

Specified by:

matchCompoundAssignment in interface BugChecker.CompoundAssignmentTreeMatcher

matchEnhancedForLoop

public Description matchEnhancedForLoop(com.sun.source.tree.EnhancedForLoopTree tree,
                                        VisitorState state)

Specified by:

matchEnhancedForLoop in interface BugChecker.EnhancedForLoopTreeMatcher

matchAssignment

public Description matchAssignment(com.sun.source.tree.AssignmentTree tree,
                                   VisitorState state)

Specified by:

matchAssignment in interface BugChecker.AssignmentTreeMatcher

matchVariable

public Description matchVariable(com.sun.source.tree.VariableTree tree,
                                 VisitorState state)

Specified by:

matchVariable in interface BugChecker.VariableTreeMatcher

matchTypeCast

public Description matchTypeCast(com.sun.source.tree.TypeCastTree tree,
                                 VisitorState state)

Specified by:

matchTypeCast in interface BugChecker.TypeCastTreeMatcher

matchReturn

public Description matchReturn(com.sun.source.tree.ReturnTree tree,
                               VisitorState state)

Specified by:

matchReturn in interface BugChecker.ReturnTreeMatcher

matchUnary

public Description matchUnary(com.sun.source.tree.UnaryTree tree,
                              VisitorState state)

Specified by:

matchUnary in interface BugChecker.UnaryTreeMatcher