com.google.errorprone.bugpatterns.javadoc

Class UnescapedEntity

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.javadoc.UnescapedEntity

All Implemented Interfaces:

BugChecker.ClassTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.VariableTreeMatcher, Suppressible, Serializable

public final class UnescapedEntity
extends BugChecker
implements BugChecker.ClassTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.VariableTreeMatcher

Finds unescaped entities in Javadocs.

Author:

ghm@google.com (Graeme Morgan)

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.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 and Description
UnescapedEntity(ErrorProneFlags flags)

Method Summary

Modifier and Type	Method and Description
Description	matchClass(com.sun.source.tree.ClassTree classTree, VisitorState state)
Description	matchMethod(com.sun.source.tree.MethodTree methodTree, VisitorState state)
Description	matchVariable(com.sun.source.tree.VariableTree variableTree, VisitorState state)

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

allNames, buildDescription, buildDescription, buildDescription, buildDescriptionFromChecker, buildDescriptionFromChecker, buildDescriptionFromChecker, canonicalName, customSuppressionAnnotations, defaultSeverity, describeMatch, describeMatch, describeMatch, equals, hashCode, isSuppressed, isSuppressed, linkUrl, message, severity, supportsSuppressWarnings

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

Constructor Detail

UnescapedEntity

public UnescapedEntity(ErrorProneFlags flags)

Method Detail

matchClass

public Description matchClass(com.sun.source.tree.ClassTree classTree,
                              VisitorState state)

Specified by:

matchClass in interface BugChecker.ClassTreeMatcher

matchMethod

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

Specified by:

matchMethod in interface BugChecker.MethodTreeMatcher

matchVariable

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

Specified by:

matchVariable in interface BugChecker.VariableTreeMatcher