com.android.tools.lint.detector.api

Class ResourceEvaluator

java.lang.Object

com.android.tools.lint.detector.api.ResourceEvaluator

public class ResourceEvaluator
extends java.lang.Object

Evaluates constant expressions

Field Summary

Fields

Modifier and Type	Field and Description
static com.android.support.AndroidxName	ANIM_RES_ANNOTATION
static com.android.support.AndroidxName	ANIMATOR_RES_ANNOTATION
static com.android.support.AndroidxName	ANY_RES_ANNOTATION
static com.android.support.AndroidxName	ARRAY_RES_ANNOTATION
static com.android.support.AndroidxName	ATTR_RES_ANNOTATION
static com.android.support.AndroidxName	BOOL_RES_ANNOTATION
static com.android.support.AndroidxName	COLOR_INT_ANNOTATION
static com.android.resources.ResourceType	COLOR_INT_MARKER_TYPE Marker ResourceType used to signify that an expression is of type @ColorInt, which isn't actually a ResourceType but one we want to specifically compare with.
static com.android.support.AndroidxName	COLOR_RES_ANNOTATION
static com.android.support.AndroidxName	DIMEN_RES_ANNOTATION
static com.android.support.AndroidxName	DIMENSION_ANNOTATION
static com.android.resources.ResourceType	DIMENSION_MARKER_TYPE Marker ResourceType used to signify that an expression is of type @Px, which isn't actually a ResourceType but one we want to specifically compare with.
static com.android.support.AndroidxName	DRAWABLE_RES_ANNOTATION
static com.android.support.AndroidxName	FONT_RES_ANNOTATION
static com.android.support.AndroidxName	FRACTION_RES_ANNOTATION
static com.android.support.AndroidxName	ID_RES_ANNOTATION
static com.android.support.AndroidxName	INTEGER_RES_ANNOTATION
static com.android.support.AndroidxName	INTERPOLATOR_RES_ANNOTATION
static com.android.support.AndroidxName	LAYOUT_RES_ANNOTATION
static com.android.support.AndroidxName	MENU_RES_ANNOTATION
static com.android.support.AndroidxName	NAVIGATION_RES_ANNOTATION
static com.android.support.AndroidxName	PLURALS_RES_ANNOTATION
static com.android.support.AndroidxName	PX_ANNOTATION
static com.android.support.AndroidxName	RAW_RES_ANNOTATION
static java.lang.String	RES_SUFFIX
static com.android.support.AndroidxName	STRING_RES_ANNOTATION
static com.android.support.AndroidxName	STYLE_RES_ANNOTATION
static com.android.support.AndroidxName	STYLEABLE_RES_ANNOTATION
static com.android.support.AndroidxName	TRANSITION_RES_ANNOTATION
static com.android.support.AndroidxName	XML_RES_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
ResourceEvaluator(com.android.tools.lint.client.api.JavaEvaluator evaluator) Creates a new resource evaluator

Method Summary

Modifier and Type	Method and Description
ResourceEvaluator	allowDereference(boolean allow) Whether we allow dereferencing resources when computing constants; e.g.
static com.android.resources.ResourceUrl	getResource(com.android.tools.lint.client.api.JavaEvaluator evaluator, com.intellij.psi.PsiElement element) Evaluates the given node and returns the resource reference (type and name) it points to, if any
static com.android.resources.ResourceUrl	getResource(com.android.tools.lint.client.api.JavaEvaluator evaluator, org.jetbrains.uast.UElement element) Evaluates the given node and returns the resource reference (type and name) it points to, if any
com.android.resources.ResourceUrl	getResource(com.intellij.psi.PsiElement element) Evaluates the given node and returns the resource reference (type and name) it points to, if any
com.android.resources.ResourceUrl	getResource(org.jetbrains.uast.UElement element) Evaluates the given node and returns the resource reference (type and name) it points to, if any
static com.android.resources.ResourceUrl	getResourceConstant(com.intellij.psi.PsiElement node) Returns a resource URL based on the field reference in the code
static com.android.resources.ResourceUrl	getResourceConstant(org.jetbrains.uast.UElement node) Returns a resource URL based on the field reference in the code
static java.util.EnumSet<com.android.resources.ResourceType>	getResourceTypes(com.android.tools.lint.client.api.JavaEvaluator evaluator, com.intellij.psi.PsiElement element) Evaluates the given node and returns the resource types implied by the given element, if any.
static java.util.EnumSet<com.android.resources.ResourceType>	getResourceTypes(com.android.tools.lint.client.api.JavaEvaluator evaluator, org.jetbrains.uast.UElement element) Evaluates the given node and returns the resource types implied by the given element, if any.
java.util.EnumSet<com.android.resources.ResourceType>	getResourceTypes(com.intellij.psi.PsiElement element) Evaluates the given node and returns the resource types applicable to the node, if any.
java.util.EnumSet<com.android.resources.ResourceType>	getResourceTypes(org.jetbrains.uast.UElement element) Evaluates the given node and returns the resource types applicable to the node, if any.
static com.android.resources.ResourceType	getTypeFromAnnotationSignature(java.lang.String signature)
static java.util.EnumSet<com.android.resources.ResourceType>	getTypesFromAnnotations(java.util.List<org.jetbrains.uast.UAnnotation> annotations)
static java.util.EnumSet<com.android.resources.ResourceType>	getTypesFromAnnotations(com.intellij.psi.PsiAnnotation[] annotations)

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_INT_MARKER_TYPE

public static final com.android.resources.ResourceType COLOR_INT_MARKER_TYPE

Marker ResourceType used to signify that an expression is of type @ColorInt, which isn't actually a ResourceType but one we want to specifically compare with. We're using ResourceType.PUBLIC because that one won't appear in the R class (and ResourceType is an enum we can't just create new constants for.)

DIMENSION_MARKER_TYPE

public static final com.android.resources.ResourceType DIMENSION_MARKER_TYPE

Marker ResourceType used to signify that an expression is of type @Px, which isn't actually a ResourceType but one we want to specifically compare with. We're using ResourceType.DECLARE_STYLEABLE because that one doesn't have a corresponding *Res constant (and ResourceType is an enum we can't just create new constants for.)

COLOR_INT_ANNOTATION

public static final com.android.support.AndroidxName COLOR_INT_ANNOTATION

PX_ANNOTATION

public static final com.android.support.AndroidxName PX_ANNOTATION

DIMENSION_ANNOTATION

public static final com.android.support.AndroidxName DIMENSION_ANNOTATION

RES_SUFFIX

public static final java.lang.String RES_SUFFIX

See Also:

Constant Field Values

ANIMATOR_RES_ANNOTATION

public static final com.android.support.AndroidxName ANIMATOR_RES_ANNOTATION

ANIM_RES_ANNOTATION

public static final com.android.support.AndroidxName ANIM_RES_ANNOTATION

ANY_RES_ANNOTATION

public static final com.android.support.AndroidxName ANY_RES_ANNOTATION

ARRAY_RES_ANNOTATION

public static final com.android.support.AndroidxName ARRAY_RES_ANNOTATION

BOOL_RES_ANNOTATION

public static final com.android.support.AndroidxName BOOL_RES_ANNOTATION

COLOR_RES_ANNOTATION

public static final com.android.support.AndroidxName COLOR_RES_ANNOTATION

ATTR_RES_ANNOTATION

public static final com.android.support.AndroidxName ATTR_RES_ANNOTATION

DIMEN_RES_ANNOTATION

public static final com.android.support.AndroidxName DIMEN_RES_ANNOTATION

DRAWABLE_RES_ANNOTATION

public static final com.android.support.AndroidxName DRAWABLE_RES_ANNOTATION

FONT_RES_ANNOTATION

public static final com.android.support.AndroidxName FONT_RES_ANNOTATION

FRACTION_RES_ANNOTATION

public static final com.android.support.AndroidxName FRACTION_RES_ANNOTATION

ID_RES_ANNOTATION

public static final com.android.support.AndroidxName ID_RES_ANNOTATION

INTEGER_RES_ANNOTATION

public static final com.android.support.AndroidxName INTEGER_RES_ANNOTATION

INTERPOLATOR_RES_ANNOTATION

public static final com.android.support.AndroidxName INTERPOLATOR_RES_ANNOTATION

LAYOUT_RES_ANNOTATION

public static final com.android.support.AndroidxName LAYOUT_RES_ANNOTATION

MENU_RES_ANNOTATION

public static final com.android.support.AndroidxName MENU_RES_ANNOTATION

PLURALS_RES_ANNOTATION

public static final com.android.support.AndroidxName PLURALS_RES_ANNOTATION

RAW_RES_ANNOTATION

public static final com.android.support.AndroidxName RAW_RES_ANNOTATION

STRING_RES_ANNOTATION

public static final com.android.support.AndroidxName STRING_RES_ANNOTATION

STYLEABLE_RES_ANNOTATION

public static final com.android.support.AndroidxName STYLEABLE_RES_ANNOTATION

STYLE_RES_ANNOTATION

public static final com.android.support.AndroidxName STYLE_RES_ANNOTATION

TRANSITION_RES_ANNOTATION

public static final com.android.support.AndroidxName TRANSITION_RES_ANNOTATION

XML_RES_ANNOTATION

public static final com.android.support.AndroidxName XML_RES_ANNOTATION

NAVIGATION_RES_ANNOTATION

public static final com.android.support.AndroidxName NAVIGATION_RES_ANNOTATION

Constructor Detail

ResourceEvaluator

public ResourceEvaluator(@Nullable
                         com.android.tools.lint.client.api.JavaEvaluator evaluator)

Creates a new resource evaluator

Parameters:

evaluator - the evaluator to use to resolve annotations references, if any

Method Detail

allowDereference

public ResourceEvaluator allowDereference(boolean allow)

Whether we allow dereferencing resources when computing constants; e.g. if we ask for the resource for x when the code is x = getString(R.string.name), if allowDereference is true we'll return R.string.name, otherwise we'll return null.

Returns:

this for constructor chaining

getResource

@Nullable
public static com.android.resources.ResourceUrl getResource(@Nullable
                                                                      com.android.tools.lint.client.api.JavaEvaluator evaluator,
                                                                      @NonNull
                                                                      com.intellij.psi.PsiElement element)

Evaluates the given node and returns the resource reference (type and name) it points to, if any

Parameters:

evaluator - the evaluator to use to look up annotations

element - the node to compute the constant value for

Returns:

the corresponding resource url (type and name)

getResource

@Nullable
public static com.android.resources.ResourceUrl getResource(@NonNull
                                                                      com.android.tools.lint.client.api.JavaEvaluator evaluator,
                                                                      @NonNull
                                                                      org.jetbrains.uast.UElement element)

Evaluates the given node and returns the resource reference (type and name) it points to, if any

Parameters:

evaluator - the evaluator to use to look up annotations

element - the node to compute the constant value for

Returns:

the corresponding resource url (type and name)

getResourceTypes

@Nullable
public static java.util.EnumSet<com.android.resources.ResourceType> getResourceTypes(@Nullable
                                                                                               com.android.tools.lint.client.api.JavaEvaluator evaluator,
                                                                                               @NonNull
                                                                                               com.intellij.psi.PsiElement element)

Evaluates the given node and returns the resource types implied by the given element, if any.

Parameters:

evaluator - the evaluator to use to look up annotations

element - the node to compute the constant value for

Returns:

the corresponding resource types

getResourceTypes

@Nullable
public static java.util.EnumSet<com.android.resources.ResourceType> getResourceTypes(@Nullable
                                                                                               com.android.tools.lint.client.api.JavaEvaluator evaluator,
                                                                                               @NonNull
                                                                                               org.jetbrains.uast.UElement element)

Evaluates the given node and returns the resource types implied by the given element, if any.

Parameters:

evaluator - the evaluator to use to look up annotations

element - the node to compute the constant value for

Returns:

the corresponding resource types

getResource

@Nullable
public com.android.resources.ResourceUrl getResource(@Nullable
                                                               org.jetbrains.uast.UElement element)

Evaluates the given node and returns the resource reference (type and name) it points to, if any

Parameters:

element - the node to compute the constant value for

Returns:

the corresponding constant value - a String, an Integer, a Float, and so on

getResource

@Nullable
public com.android.resources.ResourceUrl getResource(@Nullable
                                                               com.intellij.psi.PsiElement element)

Evaluates the given node and returns the resource reference (type and name) it points to, if any

Parameters:

element - the node to compute the constant value for

Returns:

the corresponding constant value - a String, an Integer, a Float, and so on

getResourceTypes

@Nullable
public java.util.EnumSet<com.android.resources.ResourceType> getResourceTypes(@Nullable
                                                                                        org.jetbrains.uast.UElement element)

Evaluates the given node and returns the resource types applicable to the node, if any.

Parameters:

element - the element to compute the types for

Returns:

the corresponding resource types

getResourceTypes

@Nullable
public java.util.EnumSet<com.android.resources.ResourceType> getResourceTypes(@Nullable
                                                                                        com.intellij.psi.PsiElement element)

Evaluates the given node and returns the resource types applicable to the node, if any.

Parameters:

element - the element to compute the types for

Returns:

the corresponding resource types

getTypesFromAnnotations

@Nullable
public static java.util.EnumSet<com.android.resources.ResourceType> getTypesFromAnnotations(@NonNull
                                                                                                      com.intellij.psi.PsiAnnotation[] annotations)

getTypesFromAnnotations

@Nullable
public static java.util.EnumSet<com.android.resources.ResourceType> getTypesFromAnnotations(@NonNull
                                                                                                      java.util.List<org.jetbrains.uast.UAnnotation> annotations)

getTypeFromAnnotationSignature

@Nullable
public static com.android.resources.ResourceType getTypeFromAnnotationSignature(@NonNull
                                                                                          java.lang.String signature)

getResourceConstant

@Nullable
public static com.android.resources.ResourceUrl getResourceConstant(@NonNull
                                                                              com.intellij.psi.PsiElement node)

Returns a resource URL based on the field reference in the code

getResourceConstant

@Nullable
public static com.android.resources.ResourceUrl getResourceConstant(@NonNull
                                                                              org.jetbrains.uast.UElement node)

Returns a resource URL based on the field reference in the code