Package com.palantir.baseline.errorprone

Class IllegalSafeLoggingArgument

  • All Implemented Interfaces:
    com.google.errorprone.bugpatterns.BugChecker.AssignmentTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.CompoundAssignmentTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.NewClassTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ReturnTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.VariableTreeMatcher, com.google.errorprone.matchers.Suppressible, java.io.Serializable
    @AutoService(com.google.errorprone.bugpatterns.BugChecker.class)
public final class IllegalSafeLoggingArgument
extends com.google.errorprone.bugpatterns.BugChecker
implements com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ReturnTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.AssignmentTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.CompoundAssignmentTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.VariableTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.NewClassTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher
    Ensures that safe-logging annotated elements are handled correctly by annotated method parameters. Potential future work:
    • We could check return statements in methods annotated for safety to require consistency
    • Enforce propagation of safety annotations from fields and types to types which encapsulate them.
    • More complex flow analysis to ensure safety information is respected.
    See Also:
    Serialized Form

    • Nested Class Summary

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

        com.google.errorprone.bugpatterns.BugChecker.AnnotatedTypeTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.AnnotationTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ArrayAccessTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ArrayTypeTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.AssertTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.AssignmentTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.BinaryTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.BlockTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.BreakTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.CaseTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.CatchTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.CompilationUnitTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.CompoundAssignmentTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ConditionalExpressionTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ContinueTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.DoWhileLoopTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.EmptyStatementTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.EnhancedForLoopTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ExpressionStatementTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ForLoopTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.IdentifierTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.IfTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ImportTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.InstanceOfTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.IntersectionTypeTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.LabeledStatementTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.LambdaExpressionTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.LiteralTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MemberReferenceTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MemberSelectTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ModifiersTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.NewArrayTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.NewClassTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ParameterizedTypeTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ParenthesizedTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.PrimitiveTypeTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ReturnTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.SuppressibleTreePathScanner<A extends java.lang.Object,​B extends java.lang.Object>, com.google.errorprone.bugpatterns.BugChecker.SwitchTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.SynchronizedTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.ThrowTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.TryTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.TypeCastTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.TypeParameterTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.UnaryTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.UnionTypeTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.VariableTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.WhileLoopTreeMatcher, com.google.errorprone.bugpatterns.BugChecker.WildcardTreeMatcher

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.errorprone.matchers.Description matchAssignment​(com.sun.source.tree.AssignmentTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchClass​(com.sun.source.tree.ClassTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchCompoundAssignment​(com.sun.source.tree.CompoundAssignmentTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchMethod​(com.sun.source.tree.MethodTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchMethodInvocation​(com.sun.source.tree.MethodInvocationTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchNewClass​(com.sun.source.tree.NewClassTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchReturn​(com.sun.source.tree.ReturnTree tree, com.google.errorprone.VisitorState state)  
      com.google.errorprone.matchers.Description matchVariable​(com.sun.source.tree.VariableTree tree, com.google.errorprone.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

      • IllegalSafeLoggingArgument

        public IllegalSafeLoggingArgument()

    • Method Detail

      • matchMethodInvocation

        public com.google.errorprone.matchers.Description matchMethodInvocation​(com.sun.source.tree.MethodInvocationTree tree,
                                                                        com.google.errorprone.VisitorState state)
        Specified by:
        matchMethodInvocation in interface com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher

      • matchNewClass

        public com.google.errorprone.matchers.Description matchNewClass​(com.sun.source.tree.NewClassTree tree,
                                                                com.google.errorprone.VisitorState state)
        Specified by:
        matchNewClass in interface com.google.errorprone.bugpatterns.BugChecker.NewClassTreeMatcher

      • matchReturn

        public com.google.errorprone.matchers.Description matchReturn​(com.sun.source.tree.ReturnTree tree,
                                                              com.google.errorprone.VisitorState state)
        Specified by:
        matchReturn in interface com.google.errorprone.bugpatterns.BugChecker.ReturnTreeMatcher

      • matchAssignment

        public com.google.errorprone.matchers.Description matchAssignment​(com.sun.source.tree.AssignmentTree tree,
                                                                  com.google.errorprone.VisitorState state)
        Specified by:
        matchAssignment in interface com.google.errorprone.bugpatterns.BugChecker.AssignmentTreeMatcher

      • matchCompoundAssignment

        public com.google.errorprone.matchers.Description matchCompoundAssignment​(com.sun.source.tree.CompoundAssignmentTree tree,
                                                                          com.google.errorprone.VisitorState state)
        Specified by:
        matchCompoundAssignment in interface com.google.errorprone.bugpatterns.BugChecker.CompoundAssignmentTreeMatcher

      • matchMethod

        public com.google.errorprone.matchers.Description matchMethod​(com.sun.source.tree.MethodTree tree,
                                                              com.google.errorprone.VisitorState state)
        Specified by:
        matchMethod in interface com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher

      • matchVariable

        public com.google.errorprone.matchers.Description matchVariable​(com.sun.source.tree.VariableTree tree,
                                                                com.google.errorprone.VisitorState state)
        Specified by:
        matchVariable in interface com.google.errorprone.bugpatterns.BugChecker.VariableTreeMatcher

      • matchClass

        public com.google.errorprone.matchers.Description matchClass​(com.sun.source.tree.ClassTree tree,
                                                             com.google.errorprone.VisitorState state)
        Specified by:
        matchClass in interface com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher