com.google.errorprone

Class VisitorState

java.lang.Object

com.google.errorprone.VisitorState

public class VisitorState
extends Object

Author:

[email protected] (Alex Eagle)

Field Summary

Fields

Modifier and Type	Field and Description
com.sun.tools.javac.util.Context	context

Constructor Summary

Constructors

Constructor and Description
VisitorState(com.sun.tools.javac.util.Context context)
VisitorState(com.sun.tools.javac.util.Context context, DescriptionListener listener)
VisitorState(com.sun.tools.javac.util.Context context, DescriptionListener listener, Map<String,BugPattern.SeverityLevel> severityMap, ErrorProneOptions errorProneOptions)

Method Summary

Modifier and Type	Method and Description
com.sun.tools.javac.code.Type	arrayTypeForType(com.sun.tools.javac.code.Type baseType) Build an Array Type from another Type
ErrorProneOptions	errorProneOptions()
<T extends com.sun.source.tree.Tree> T	findEnclosing(Class<? extends T>... classes) Find the first enclosing tree node of one of the given types.
com.sun.source.util.TreePath	findPathToEnclosing(Class<? extends com.sun.source.tree.Tree>... classes) Returns the TreePath to the nearest tree node of one of the given types.
int	getEndPosition(com.sun.source.tree.Tree node) Returns the end position of the node, or -1 if it is not available.
com.sun.tools.javac.util.Name	getName(String nameStr)
NullnessAnalysis	getNullnessAnalysis()
com.sun.source.util.TreePath	getPath()
CharSequence	getSourceCode() Gets the current source file.
String	getSourceForNode(com.sun.source.tree.Tree tree) Gets the original source code that represents the given node.
com.sun.tools.javac.code.Symbol	getSymbolFromString(String symStr)
com.sun.tools.javac.code.Symtab	getSymtab()
List<ErrorProneToken>	getTokensForNode(com.sun.source.tree.Tree tree) Returns the list of Tokens.Tokens for the given JCTree.
com.sun.tools.javac.tree.TreeMaker	getTreeMaker()
com.sun.tools.javac.code.Type	getType(com.sun.tools.javac.code.Type baseType, boolean isArray, List<com.sun.tools.javac.code.Type> typeParams) Build an instance of a Type.
com.sun.tools.javac.code.Type	getTypeFromString(String typeStr) Given the binary name of a class, returns the Type.
com.sun.tools.javac.code.Types	getTypes()
com.sun.tools.javac.code.Symbol.ModuleSymbol	inferModule(com.sun.tools.javac.util.Name flatName) Infers a module symbol for the given flat class name.
boolean	isAndroidCompatible() Returns true if the compilation is targeting Android.
void	reportMatch(Description description)
VisitorState	withPath(com.sun.source.util.TreePath path)

Methods inherited from class java.lang.Object

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

Field Detail

context

public final com.sun.tools.javac.util.Context context

Constructor Detail

VisitorState

public VisitorState(com.sun.tools.javac.util.Context context)

VisitorState

public VisitorState(com.sun.tools.javac.util.Context context,
                    DescriptionListener listener)

VisitorState

public VisitorState(com.sun.tools.javac.util.Context context,
                    DescriptionListener listener,
                    Map<String,BugPattern.SeverityLevel> severityMap,
                    ErrorProneOptions errorProneOptions)

Method Detail

withPath

public VisitorState withPath(com.sun.source.util.TreePath path)

getPath

public com.sun.source.util.TreePath getPath()

getTreeMaker

public com.sun.tools.javac.tree.TreeMaker getTreeMaker()

getTypes

public com.sun.tools.javac.code.Types getTypes()

getSymtab

public com.sun.tools.javac.code.Symtab getSymtab()

getNullnessAnalysis

public NullnessAnalysis getNullnessAnalysis()

errorProneOptions

public ErrorProneOptions errorProneOptions()

reportMatch

public void reportMatch(Description description)

getName

public com.sun.tools.javac.util.Name getName(String nameStr)

getTypeFromString

public com.sun.tools.javac.code.Type getTypeFromString(String typeStr)

Given the binary name of a class, returns the Type.

If this method returns null, the compiler doesn't have access to this type, which means that if you are comparing other types to this for equality or the subtype relation, your result would always be false even if it could create the type. Thus it might be best to bail out early in your matcher if this method returns null on your type of interest.

Parameters:

typeStr - the JLS 13.1 binary name of the class, e.g. "java.util.Map$Entry"

Returns:

the Type, or null if it cannot be found

inferModule

public com.sun.tools.javac.code.Symbol.ModuleSymbol inferModule(com.sun.tools.javac.util.Name flatName)

Infers a module symbol for the given flat class name.

getSymbolFromString

public com.sun.tools.javac.code.Symbol getSymbolFromString(String symStr)

Parameters:

symStr - the string representation of a symbol

Returns:

the Symbol object, or null if it cannot be found

getType

public com.sun.tools.javac.code.Type getType(com.sun.tools.javac.code.Type baseType,
                                             boolean isArray,
                                             List<com.sun.tools.javac.code.Type> typeParams)

Build an instance of a Type.

arrayTypeForType

public com.sun.tools.javac.code.Type arrayTypeForType(com.sun.tools.javac.code.Type baseType)

Build an Array Type from another Type

findPathToEnclosing

@SafeVarargs
public final com.sun.source.util.TreePath findPathToEnclosing(Class<? extends com.sun.source.tree.Tree>... classes)

Returns the TreePath to the nearest tree node of one of the given types. To instead retrieve the element directly, use findEnclosing(Class...).

Returns:

the path, or null if there is no match

findEnclosing

@SafeVarargs
public final <T extends com.sun.source.tree.Tree> T findEnclosing(Class<? extends T>... classes)

Find the first enclosing tree node of one of the given types.

Returns:

the node, or null if there is no match

getSourceCode

public CharSequence getSourceCode()

Gets the current source file.

Returns:

the source file as a sequence of characters, or null if it is not available

getSourceForNode

public String getSourceForNode(com.sun.source.tree.Tree tree)

Gets the original source code that represents the given node.

Note that this may be different from what is returned by calling .toString() on the node. This returns exactly what is in the source code, whereas .toString() pretty-prints the node from its AST representation.

Returns:

the source code that represents the node.

getTokensForNode

public List<ErrorProneToken> getTokensForNode(com.sun.source.tree.Tree tree)

Returns the list of Tokens.Tokens for the given JCTree.

This is moderately expensive (the source of the node has to be re-lexed), so it should only be used if a fix is already going to be emitted.

getEndPosition

public int getEndPosition(com.sun.source.tree.Tree node)

Returns the end position of the node, or -1 if it is not available.

isAndroidCompatible

public boolean isAndroidCompatible()

Returns true if the compilation is targeting Android.