com.android.tools.lint.client.api

Class JavaParser

java.lang.Object

com.android.tools.lint.client.api.JavaParser

@Beta
public abstract class JavaParser
extends java.lang.Object

A wrapper for a Java parser. This allows tools integrating lint to map directly to builtin services, such as already-parsed data structures in Java editors.

NOTE: This is not public or final API; if you rely on this be prepared to adjust your code for the next tools release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaParser.DefaultTypeDescriptor Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedAnnotation Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedClass Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedField Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedMethod Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedNode Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedPackage Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.ResolvedVariable Deprecated. Use Detector.JavaPsiScanner APIs instead
static class	JavaParser.TypeDescriptor Deprecated. Use PsiType instead

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_BOOLEAN
static java.lang.String	TYPE_BOOLEAN_WRAPPER
static java.lang.String	TYPE_BYTE
static java.lang.String	TYPE_BYTE_WRAPPER
static java.lang.String	TYPE_CHAR
static java.lang.String	TYPE_CHARACTER_WRAPPER
static java.lang.String	TYPE_DOUBLE
static java.lang.String	TYPE_DOUBLE_WRAPPER
static java.lang.String	TYPE_FLOAT
static java.lang.String	TYPE_FLOAT_WRAPPER
static java.lang.String	TYPE_INT
static java.lang.String	TYPE_INTEGER_WRAPPER
static java.lang.String	TYPE_LONG
static java.lang.String	TYPE_LONG_WRAPPER
static java.lang.String	TYPE_NULL
static java.lang.String	TYPE_OBJECT
static java.lang.String	TYPE_SHORT
static java.lang.String	TYPE_SHORT_WRAPPER
static java.lang.String	TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
JavaParser()

Method Summary

Modifier and Type	Method and Description
com.android.tools.lint.detector.api.Location	createLocation(com.intellij.psi.PsiElement element)
abstract com.android.tools.lint.detector.api.Location.Handle	createLocationHandle(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node node) Deprecated. Use PSI instead (where handles aren't necessary; use PsiElement directly)
void	dispose() Dispose any remaining data structures held for all contexts.
void	dispose(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node compilationUnit) Deprecated. Use dispose(JavaContext, PsiJavaFile) instead
void	dispose(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiJavaFile compilationUnit) Dispose any data structures held for the given context.
void	dispose(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UFile compilationUnit) Dispose any data structures held for the given context.
JavaParser.ResolvedClass	findClass(com.android.tools.lint.detector.api.JavaContext context, java.lang.String fullyQualifiedName) Finds the given type, if possible (which should be reachable from the compilation patch of the given node.
abstract com.intellij.psi.PsiElement	findElementAt(com.android.tools.lint.detector.api.JavaContext context, int offset) Returns the leaf element at the given offset (biased towards the right), or null if not found
java.util.List<JavaParser.TypeDescriptor>	getCatchTypes(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Catch catchBlock) Deprecated. Use Detector.JavaPsiScanner APIs instead
abstract JavaEvaluator	getEvaluator() Returns an evaluator which can perform various resolution tasks, evaluate inheritance lookup etc.
abstract java.io.File	getFile(com.intellij.psi.PsiFile file)
java.lang.CharSequence	getFileContents(com.intellij.psi.PsiFile file)
com.android.tools.lint.detector.api.Location	getLocation(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node node) Deprecated. Use getNameLocation(JavaContext, PsiElement) instead
com.android.tools.lint.detector.api.Location	getLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement element) Returns a Location for the given element
com.android.tools.lint.detector.api.Location	getNameLocation(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node node) Deprecated. Use getNameLocation(JavaContext, PsiElement) instead
com.android.tools.lint.detector.api.Location	getNameLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement element) Returns a Location for the given node.
abstract com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node from, int fromDelta, lombok.ast.Node to, int toDelta) Deprecated. Use getRangeLocation(JavaContext, PsiElement, int, PsiElement, int) instead
com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement from, int fromDelta, int toDelta) Like getRangeLocation(JavaContext, PsiElement, int, PsiElement, int) but both offsets are relative to the starting offset of the given node.
com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement from, int fromDelta, com.intellij.psi.PsiElement to, int toDelta) Returns a Location for the given node range (from the starting offset of the first node to the ending offset of the second node).
JavaParser.TypeDescriptor	getType(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node node) Deprecated. Use Detector.JavaPsiScanner APIs instead
lombok.ast.Node	parseJava(com.android.tools.lint.detector.api.JavaContext context) Deprecated. Use parseJavaToPsi(JavaContext) instead
abstract com.intellij.psi.PsiJavaFile	parseJavaToPsi(com.android.tools.lint.detector.api.JavaContext context) Parse the file pointed to by the given context.
abstract boolean	prepareJavaParse(java.util.List<com.android.tools.lint.detector.api.JavaContext> contexts) Prepare to parse the given contexts.
JavaParser.ResolvedNode	resolve(com.android.tools.lint.detector.api.JavaContext context, lombok.ast.Node node) Deprecated. Use Detector.JavaPsiScanner APIs instead

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_OBJECT

public static final java.lang.String TYPE_OBJECT

See Also:

Constant Field Values

TYPE_STRING

public static final java.lang.String TYPE_STRING

See Also:

Constant Field Values

TYPE_INT

public static final java.lang.String TYPE_INT

See Also:

Constant Field Values

TYPE_LONG

public static final java.lang.String TYPE_LONG

See Also:

Constant Field Values

TYPE_CHAR

public static final java.lang.String TYPE_CHAR

See Also:

Constant Field Values

TYPE_FLOAT

public static final java.lang.String TYPE_FLOAT

See Also:

Constant Field Values

TYPE_DOUBLE

public static final java.lang.String TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final java.lang.String TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_SHORT

public static final java.lang.String TYPE_SHORT

See Also:

Constant Field Values

TYPE_BYTE

public static final java.lang.String TYPE_BYTE

See Also:

Constant Field Values

TYPE_NULL

public static final java.lang.String TYPE_NULL

See Also:

Constant Field Values

TYPE_INTEGER_WRAPPER

public static final java.lang.String TYPE_INTEGER_WRAPPER

See Also:

Constant Field Values

TYPE_BOOLEAN_WRAPPER

public static final java.lang.String TYPE_BOOLEAN_WRAPPER

See Also:

Constant Field Values

TYPE_BYTE_WRAPPER

public static final java.lang.String TYPE_BYTE_WRAPPER

See Also:

Constant Field Values

TYPE_SHORT_WRAPPER

public static final java.lang.String TYPE_SHORT_WRAPPER

See Also:

Constant Field Values

TYPE_LONG_WRAPPER

public static final java.lang.String TYPE_LONG_WRAPPER

See Also:

Constant Field Values

TYPE_DOUBLE_WRAPPER

public static final java.lang.String TYPE_DOUBLE_WRAPPER

See Also:

Constant Field Values

TYPE_FLOAT_WRAPPER

public static final java.lang.String TYPE_FLOAT_WRAPPER

See Also:

Constant Field Values

TYPE_CHARACTER_WRAPPER

public static final java.lang.String TYPE_CHARACTER_WRAPPER

See Also:

Constant Field Values

Constructor Detail

JavaParser

public JavaParser()

Method Detail

prepareJavaParse

public abstract boolean prepareJavaParse(@NonNull
                                         java.util.List<com.android.tools.lint.detector.api.JavaContext> contexts)

Prepare to parse the given contexts. This method will be called before a series of parseJava(JavaContext) calls, which allows some parsers to do up front global computation in case they want to more efficiently process multiple files at the same time. This allows a single type-attribution pass for example, which is a lot more efficient than performing global type analysis over and over again for each individual file

Parameters:

contexts - a list of contexts to be parsed

Returns:

true if the preparation succeeded; false if there were errors

parseJava

@Deprecated
 @Nullable
public lombok.ast.Node parseJava(@NonNull
                                                        com.android.tools.lint.detector.api.JavaContext context)

Deprecated. Use parseJavaToPsi(JavaContext) instead

Parse the file pointed to by the given context.

Parameters:

context - the context pointing to the file to be parsed, typically via Context.getContents() but the file handle ( Context.file can also be used to map to an existing editor buffer in the surrounding tool, etc)

Returns:

the compilation unit node for the file

parseJavaToPsi

@Nullable
public abstract com.intellij.psi.PsiJavaFile parseJavaToPsi(@NonNull
                                                                      com.android.tools.lint.detector.api.JavaContext context)

Parse the file pointed to by the given context.

Parameters:

context - the context pointing to the file to be parsed, typically via Context.getContents() but the file handle ( Context.file can also be used to map to an existing editor buffer in the surrounding tool, etc)

Returns:

the compilation unit node for the file

getEvaluator

@NonNull
public abstract JavaEvaluator getEvaluator()

Returns an evaluator which can perform various resolution tasks, evaluate inheritance lookup etc.

Returns:

an evaluator

getLocation

@Deprecated
 @NonNull
public com.android.tools.lint.detector.api.Location getLocation(@NonNull
                                                                                      com.android.tools.lint.detector.api.JavaContext context,
                                                                                      @NonNull
                                                                                      lombok.ast.Node node)

Deprecated. Use getNameLocation(JavaContext, PsiElement) instead

Returns a Location for the given node

Parameters:

context - information about the file being parsed

node - the node to create a location for

Returns:

a location for the given node

getLocation

@NonNull
public com.android.tools.lint.detector.api.Location getLocation(@NonNull
                                                                         com.android.tools.lint.detector.api.JavaContext context,
                                                                         @NonNull
                                                                         com.intellij.psi.PsiElement element)

Returns a Location for the given element

Parameters:

context - information about the file being parsed

element - the element to create a location for

Returns:

a location for the given node

getFile

@Nullable
public abstract java.io.File getFile(@NonNull
                                               com.intellij.psi.PsiFile file)

getFileContents

@NonNull
public java.lang.CharSequence getFileContents(@NonNull
                                                       com.intellij.psi.PsiFile file)

createLocation

@NonNull
public com.android.tools.lint.detector.api.Location createLocation(@NonNull
                                                                            com.intellij.psi.PsiElement element)

getRangeLocation

@Deprecated
 @NonNull
public abstract com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                                                    com.android.tools.lint.detector.api.JavaContext context,
                                                                                                    @NonNull
                                                                                                    lombok.ast.Node from,
                                                                                                    int fromDelta,
                                                                                                    @NonNull
                                                                                                    lombok.ast.Node to,
                                                                                                    int toDelta)

Deprecated. Use getRangeLocation(JavaContext, PsiElement, int, PsiElement, int) instead

Returns a Location for the given node range (from the starting offset of the first node to the ending offset of the second node).

Parameters:

context - information about the file being parsed

from - the AST node to get a starting location from

fromDelta - Offset delta to apply to the starting offset

to - the AST node to get a ending location from

toDelta - Offset delta to apply to the ending offset

Returns:

a location for the given node

getRangeLocation

@NonNull
public com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                              com.android.tools.lint.detector.api.JavaContext context,
                                                                              @NonNull
                                                                              com.intellij.psi.PsiElement from,
                                                                              int fromDelta,
                                                                              @NonNull
                                                                              com.intellij.psi.PsiElement to,
                                                                              int toDelta)

Returns a Location for the given node range (from the starting offset of the first node to the ending offset of the second node).

Parameters:

context - information about the file being parsed

from - the AST node to get a starting location from

fromDelta - Offset delta to apply to the starting offset

to - the AST node to get a ending location from

toDelta - Offset delta to apply to the ending offset

Returns:

a location for the given node

getRangeLocation

@NonNull
public com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                              com.android.tools.lint.detector.api.JavaContext context,
                                                                              @NonNull
                                                                              com.intellij.psi.PsiElement from,
                                                                              int fromDelta,
                                                                              int toDelta)

Like getRangeLocation(JavaContext, PsiElement, int, PsiElement, int) but both offsets are relative to the starting offset of the given node. This is sometimes more convenient than operating relative to the ending offset when you have a fixed range in mind.

Parameters:

context - information about the file being parsed

from - the AST node to get a starting location from

fromDelta - Offset delta to apply to the starting offset

toDelta - Offset delta to apply to the starting offset

Returns:

a location for the given node

getNameLocation

@Deprecated
 @NonNull
public com.android.tools.lint.detector.api.Location getNameLocation(@NonNull
                                                                                          com.android.tools.lint.detector.api.JavaContext context,
                                                                                          @NonNull
                                                                                          lombok.ast.Node node)

Deprecated. Use getNameLocation(JavaContext, PsiElement) instead

Returns a Location for the given node. This attempts to pick a shorter location range than the entire node; for a class or method for example, it picks the name node (if found). For statement constructs such as a switch statement it will highlight the keyword, etc.

Parameters:

context - information about the file being parsed

node - the node to create a location for

Returns:

a location for the given node

findElementAt

@Nullable
public abstract com.intellij.psi.PsiElement findElementAt(@NonNull
                                                                    com.android.tools.lint.detector.api.JavaContext context,
                                                                    int offset)

Returns the leaf element at the given offset (biased towards the right), or null if not found

Parameters:

offset - the offset to search at

Returns:

the leaf element, if any

getNameLocation

@NonNull
public com.android.tools.lint.detector.api.Location getNameLocation(@NonNull
                                                                             com.android.tools.lint.detector.api.JavaContext context,
                                                                             @NonNull
                                                                             com.intellij.psi.PsiElement element)

Returns a Location for the given node. This attempts to pick a shorter location range than the entire node; for a class or method for example, it picks the name node (if found). For statement constructs such as a switch statement it will highlight the keyword, etc.

Parameters:

context - information about the file being parsed

element - the node to create a location for

Returns:

a location for the given node

createLocationHandle

@Deprecated
 @NonNull
public abstract com.android.tools.lint.detector.api.Location.Handle createLocationHandle(@NonNull
                                                                                                               com.android.tools.lint.detector.api.JavaContext context,
                                                                                                               @NonNull
                                                                                                               lombok.ast.Node node)

Deprecated. Use PSI instead (where handles aren't necessary; use PsiElement directly)

Creates a light-weight handle to a location for the given node. It can be turned into a full fledged location by Location.Handle.resolve().

Parameters:

context - the context providing the node

node - the node (element or attribute) to create a location handle for

Returns:

a location handle

dispose

@Deprecated
public void dispose(@NonNull
                                com.android.tools.lint.detector.api.JavaContext context,
                                @NonNull
                                lombok.ast.Node compilationUnit)

Deprecated. Use dispose(JavaContext, PsiJavaFile) instead

Dispose any data structures held for the given context.

Parameters:

context - information about the file previously parsed

compilationUnit - the compilation unit being disposed

dispose

public void dispose(@NonNull
                    com.android.tools.lint.detector.api.JavaContext context,
                    @NonNull
                    com.intellij.psi.PsiJavaFile compilationUnit)

Dispose any data structures held for the given context.

Parameters:

context - information about the file previously parsed

compilationUnit - the compilation unit being disposed

dispose

public void dispose(@NonNull
                    com.android.tools.lint.detector.api.JavaContext context,
                    @NonNull
                    org.jetbrains.uast.UFile compilationUnit)

Dispose any data structures held for the given context.

Parameters:

context - information about the file previously parsed

compilationUnit - the compilation unit being disposed

dispose

public void dispose()

Dispose any remaining data structures held for all contexts. Typically frees up any resources allocated by prepareJavaParse(List)

resolve

@Deprecated
 @Nullable
public JavaParser.ResolvedNode resolve(@NonNull
                                                              com.android.tools.lint.detector.api.JavaContext context,
                                                              @NonNull
                                                              lombok.ast.Node node)

Deprecated. Use Detector.JavaPsiScanner APIs instead

Resolves the given expression node: computes the declaration for the given symbol

Parameters:

context - information about the file being parsed

node - the node to resolve

Returns:

a node representing the resolved fully type: class/interface/annotation, field, method or variable

findClass

@Nullable
public JavaParser.ResolvedClass findClass(@NonNull
                                                    com.android.tools.lint.detector.api.JavaContext context,
                                                    @NonNull
                                                    java.lang.String fullyQualifiedName)

Finds the given type, if possible (which should be reachable from the compilation patch of the given node.

Parameters:

context - information about the file being parsed

fullyQualifiedName - the fully qualified name of the class to look up

Returns:

the class, or null if not found

getCatchTypes

@Deprecated
public java.util.List<JavaParser.TypeDescriptor> getCatchTypes(@NonNull
                                                                           com.android.tools.lint.detector.api.JavaContext context,
                                                                           @NonNull
                                                                           lombok.ast.Catch catchBlock)

Deprecated. Use Detector.JavaPsiScanner APIs instead

Returns the set of exception types handled by the given catch block.

This is a workaround for the fact that the Lombok AST API (and implementation) doesn't support multi-catch statements.

getType

@Deprecated
 @Nullable
public JavaParser.TypeDescriptor getType(@NonNull
                                                                com.android.tools.lint.detector.api.JavaContext context,
                                                                @NonNull
                                                                lombok.ast.Node node)

Deprecated. Use Detector.JavaPsiScanner APIs instead

Gets the type of the given node

Parameters:

context - information about the file being parsed

node - the node to look up the type for

Returns:

the type of the node, if known