Class ArrayToString

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.AbstractToString

com.google.errorprone.bugpatterns.ArrayToString

All Implemented Interfaces:

BugChecker.BinaryTreeMatcher, BugChecker.CompoundAssignmentTreeMatcher, BugChecker.MemberReferenceTreeMatcher, BugChecker.MethodInvocationTreeMatcher, Suppressible, Serializable

public class ArrayToString
extends AbstractToString

Author:

adgar@google.com (Mike Edgar), cushon@google.com (Liam Miller-Cushon)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class BugChecker

BugChecker.AnnotatedTypeTreeMatcher, BugChecker.AnnotationTreeMatcher, BugChecker.ArrayAccessTreeMatcher, BugChecker.ArrayTypeTreeMatcher, BugChecker.AssertTreeMatcher, BugChecker.AssignmentTreeMatcher, BugChecker.BinaryTreeMatcher, BugChecker.BindingPatternTreeMatcher, BugChecker.BlockTreeMatcher, BugChecker.BreakTreeMatcher, BugChecker.CaseTreeMatcher, BugChecker.CatchTreeMatcher, BugChecker.ClassTreeMatcher, BugChecker.CompilationUnitTreeMatcher, BugChecker.CompoundAssignmentTreeMatcher, BugChecker.ConditionalExpressionTreeMatcher, BugChecker.ConstantCaseLabelTreeMatcher, BugChecker.ContinueTreeMatcher, BugChecker.DeconstructionPatternTreeMatcher, BugChecker.DefaultCaseLabelTreeMatcher, BugChecker.DoWhileLoopTreeMatcher, BugChecker.EmptyStatementTreeMatcher, BugChecker.EnhancedForLoopTreeMatcher, BugChecker.ExportsTreeMatcher, 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.ModuleTreeMatcher, BugChecker.NewArrayTreeMatcher, BugChecker.NewClassTreeMatcher, BugChecker.OpensTreeMatcher, BugChecker.PackageTreeMatcher, BugChecker.ParameterizedTypeTreeMatcher, BugChecker.ParenthesizedTreeMatcher, BugChecker.PatternCaseLabelTreeMatcher, BugChecker.PrimitiveTypeTreeMatcher, BugChecker.ProvidesTreeMatcher, BugChecker.RequiresTreeMatcher, BugChecker.ReturnTreeMatcher, BugChecker.SuppressibleTreePathScanner<R,P>, BugChecker.SwitchExpressionTreeMatcher, BugChecker.SwitchTreeMatcher, BugChecker.SynchronizedTreeMatcher, BugChecker.ThrowTreeMatcher, BugChecker.TryTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.TypeParameterTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.UnionTypeTreeMatcher, BugChecker.UsesTreeMatcher, BugChecker.VariableTreeMatcher, BugChecker.WhileLoopTreeMatcher, BugChecker.WildcardTreeMatcher, BugChecker.YieldTreeMatcher

Method Summary

Modifier and Type	Method	Description
protected boolean	allowableToStringKind(com.google.errorprone.bugpatterns.AbstractToString.ToStringKind toStringKind)	Whether this kind of toString call is allowable for this check.
protected Optional<Fix>	implicitToStringFix(ExpressionTree stringifiedExpr, VisitorState state)	Constructs a fix for an implicit toString call, e.g. from string concatenation or from passing an argument to println or StringBuilder.append.
protected Optional<Fix>	memberReferenceFix(MemberReferenceTree tree, com.sun.tools.javac.code.Type receiverType, VisitorState state)	Constructs a fix for a method reference to toString(), e.g.
protected Optional<Fix>	toStringFix(Tree toStringCall, ExpressionTree stringifiedExpr, VisitorState state)	Constructs a fix for an explicit toString call, e.g. from Object.toString() or String.valueOf().
protected TypePredicate	typePredicate()	The type to match on.

Methods inherited from class AbstractToString

descriptionMessageForDefaultMatch, matchBinary, matchCompoundAssignment, matchMemberReference, matchMethodInvocation

Methods inherited from class BugChecker

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

Methods inherited from class Object

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

Methods inherited from interface Suppressible

allNames, canonicalName, customSuppressionAnnotations, supportsSuppressWarnings, suppressedByAnyOf

Method Details

typePredicate

protected TypePredicate typePredicate()

Description copied from class: AbstractToString

The type to match on.

Specified by:

typePredicate in class AbstractToString

implicitToStringFix

protected Optional<Fix> implicitToStringFix(ExpressionTree stringifiedExpr,
 VisitorState state)

Description copied from class: AbstractToString

Constructs a fix for an implicit toString call, e.g. from string concatenation or from passing an argument to println or StringBuilder.append.

Specified by:

implicitToStringFix in class AbstractToString

Parameters:

stringifiedExpr - the tree node for the expression being converted to a String

allowableToStringKind

protected boolean allowableToStringKind(com.google.errorprone.bugpatterns.AbstractToString.ToStringKind toStringKind)

Description copied from class: AbstractToString

Whether this kind of toString call is allowable for this check.

Overrides:

allowableToStringKind in class AbstractToString

toStringFix

protected Optional<Fix> toStringFix(Tree toStringCall,
 ExpressionTree stringifiedExpr,
 VisitorState state)

Description copied from class: AbstractToString

Constructs a fix for an explicit toString call, e.g. from Object.toString() or String.valueOf().

Specified by:

toStringFix in class AbstractToString

Parameters:

toStringCall - the MethodInvocationTree corresponding to the explicit string conversion: either x.toString() or String.valueOf(x)

stringifiedExpr - the ExpressionTree that is being converted to a string (the receiver x in x.toString(), or the argument x in String.valueOf(x))

memberReferenceFix

protected Optional<Fix> memberReferenceFix(MemberReferenceTree tree,
 com.sun.tools.javac.code.Type receiverType,
 VisitorState state)

Description copied from class: AbstractToString

Constructs a fix for a method reference to toString(), e.g. Object::toString.

Overrides:

memberReferenceFix in class AbstractToString

Parameters:

receiverType - the type of the object toString() will be called on