com.android.tools.lint.annotations

Class Extractor

java.lang.Object

com.android.tools.lint.annotations.Extractor

public class Extractor
extends java.lang.Object

Annotation extractor which looks for annotations in parsed compilation units and writes the annotations into a format suitable for use by IntelliJ and Android Studio etc; it's basically an XML file, organized by package, which lists the signatures for fields and methods in classes in the given package, and identifiers method parameters by index, and lists the annotations annotated on that element.

This is primarily intended for use in Android libraries such as the support library, where you want to use the resource int (StringRes, DrawableRes, and so on) annotations to indicate what types of id's are expected, or the IntDef or StringDef annotations to record which specific constants are allowed in int and String parameters.

However, the code is also used to extract SDK annotations from the platform, where the package names of the annotations differ slightly (and where the nullness annotations do not have class retention for example). Therefore, this code contains some extra support not needed when extracting annotations in an Android library, such as code to skip annotations for any method/field not mentioned in the API database, and code to rewrite the android.jar file to insert annotations in the generated bytecode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extractor.ClassKind

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANDROID_ANNOTATIONS_PREFIX
static java.lang.String	ANDROID_INT_DEF
static java.lang.String	ANDROID_INT_RANGE
static java.lang.String	ANDROID_LONG_DEF
static java.lang.String	ANDROID_NOTNULL
static java.lang.String	ANDROID_NULLABLE
static java.lang.String	ANDROID_REQUIRES_PERMISSION
static java.lang.String	ANDROID_STRING_DEF
static java.lang.String	ATTR_PURE
static java.lang.String	ATTR_VAL
static java.lang.String	IDEA_CONTRACT
static java.lang.String	IDEA_MAGIC
static java.lang.String	IDEA_NON_NLS
static java.lang.String	IDEA_NOTNULL
static java.lang.String	IDEA_NULLABLE
static boolean	REMOVE_HIDDEN_TYPEDEFS If true, remove typedefs (even public ones) if they are marked with @hide.
static java.lang.String	REQUIRES_PERMISSION
static java.lang.String	RESOURCE_TYPE_ANNOTATIONS_SUFFIX
static java.lang.String	SUPPORT_KEEP
static java.lang.String	SUPPORT_NOTNULL
static java.lang.String	SUPPORT_NULLABLE

Constructor Summary

Constructors

Constructor and Description
Extractor(ApiDatabase apiFilter, java.util.Collection<java.io.File> classDir, boolean displayInfo, boolean includeClassRetentionAnnotations, boolean sortAnnotations)

Method Summary

Modifier and Type	Method and Description
static void	addJavaSources(java.util.List<java.io.File> list, java.io.File file)
com.android.tools.lint.annotations.Extractor.AnnotationData	createData(java.lang.String name, org.jetbrains.uast.UAnnotation annotation)
static java.util.List<? extends com.intellij.psi.PsiFile>	createUnitsForFiles(com.intellij.openapi.project.Project project, java.util.List<java.io.File> specificSources)
static java.util.List<? extends com.intellij.psi.PsiFile>	createUnitsInDirectories(com.intellij.openapi.project.Project project, java.util.List<java.io.File> sourceDirs)
void	export(java.io.File annotationsZip, java.io.File proguardCfg)
void	extractFromProjectSource(java.util.List<? extends com.intellij.psi.PsiFile> units)
static java.util.List<java.io.File>	gatherSources(java.util.List<java.io.File> sourcePath)
static boolean	isHiddenTypeDef(org.jetbrains.uast.UClass declaration) Returns true if this type declaration for a typedef is hidden (e.g.
boolean	isListIgnored()
void	mergeExisting(java.io.File file)
void	removeTypedefClasses()
static void	removeTypedefClasses(java.util.Collection<java.io.File> classDirs, java.io.File typedefFile)
void	setListIgnored(boolean listIgnored)
void	writeStats()
void	writeTypedefFile(java.io.File file)

Methods inherited from class java.lang.Object

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

Field Detail

REMOVE_HIDDEN_TYPEDEFS

public static final boolean REMOVE_HIDDEN_TYPEDEFS

If true, remove typedefs (even public ones) if they are marked with @hide. This is disabled because for some reason, the ECJ nodes do not provide valid contents of javadoc entries for classes.

See Also:

Constant Field Values

ANDROID_ANNOTATIONS_PREFIX

public static final java.lang.String ANDROID_ANNOTATIONS_PREFIX

See Also:

Constant Field Values

ANDROID_NULLABLE

public static final java.lang.String ANDROID_NULLABLE

See Also:

Constant Field Values

SUPPORT_NULLABLE

public static final java.lang.String SUPPORT_NULLABLE

See Also:

Constant Field Values

SUPPORT_KEEP

public static final java.lang.String SUPPORT_KEEP

See Also:

Constant Field Values

RESOURCE_TYPE_ANNOTATIONS_SUFFIX

public static final java.lang.String RESOURCE_TYPE_ANNOTATIONS_SUFFIX

See Also:

Constant Field Values

ANDROID_NOTNULL

public static final java.lang.String ANDROID_NOTNULL

See Also:

Constant Field Values

SUPPORT_NOTNULL

public static final java.lang.String SUPPORT_NOTNULL

See Also:

Constant Field Values

ANDROID_INT_DEF

public static final java.lang.String ANDROID_INT_DEF

See Also:

Constant Field Values

ANDROID_LONG_DEF

public static final java.lang.String ANDROID_LONG_DEF

See Also:

Constant Field Values

ANDROID_INT_RANGE

public static final java.lang.String ANDROID_INT_RANGE

See Also:

Constant Field Values

ANDROID_STRING_DEF

public static final java.lang.String ANDROID_STRING_DEF

See Also:

Constant Field Values

REQUIRES_PERMISSION

public static final java.lang.String REQUIRES_PERMISSION

See Also:

Constant Field Values

ANDROID_REQUIRES_PERMISSION

public static final java.lang.String ANDROID_REQUIRES_PERMISSION

See Also:

Constant Field Values

IDEA_NULLABLE

public static final java.lang.String IDEA_NULLABLE

See Also:

Constant Field Values

IDEA_NOTNULL

public static final java.lang.String IDEA_NOTNULL

See Also:

Constant Field Values

IDEA_MAGIC

public static final java.lang.String IDEA_MAGIC

See Also:

Constant Field Values

IDEA_CONTRACT

public static final java.lang.String IDEA_CONTRACT

See Also:

Constant Field Values

IDEA_NON_NLS

public static final java.lang.String IDEA_NON_NLS

See Also:

Constant Field Values

ATTR_VAL

public static final java.lang.String ATTR_VAL

See Also:

Constant Field Values

ATTR_PURE

public static final java.lang.String ATTR_PURE

See Also:

Constant Field Values

Constructor Detail

Extractor

public Extractor(@Nullable
                 ApiDatabase apiFilter,
                 @Nullable
                 java.util.Collection<java.io.File> classDir,
                 boolean displayInfo,
                 boolean includeClassRetentionAnnotations,
                 boolean sortAnnotations)

Method Detail

createUnitsForFiles

public static java.util.List<? extends com.intellij.psi.PsiFile> createUnitsForFiles(@NonNull
                                                                                     com.intellij.openapi.project.Project project,
                                                                                     @NonNull
                                                                                     java.util.List<java.io.File> specificSources)

createUnitsInDirectories

public static java.util.List<? extends com.intellij.psi.PsiFile> createUnitsInDirectories(@NonNull
                                                                                          com.intellij.openapi.project.Project project,
                                                                                          @NonNull
                                                                                          java.util.List<java.io.File> sourceDirs)

addJavaSources

public static void addJavaSources(@NonNull
                                  java.util.List<java.io.File> list,
                                  @NonNull
                                  java.io.File file)

gatherSources

public static java.util.List<java.io.File> gatherSources(java.util.List<java.io.File> sourcePath)

extractFromProjectSource

public void extractFromProjectSource(java.util.List<? extends com.intellij.psi.PsiFile> units)

removeTypedefClasses

public void removeTypedefClasses()

writeTypedefFile

public void writeTypedefFile(@NonNull
                             java.io.File file)
                      throws java.io.IOException

Throws:

java.io.IOException

removeTypedefClasses

public static void removeTypedefClasses(@NonNull
                                        java.util.Collection<java.io.File> classDirs,
                                        @NonNull
                                        java.io.File typedefFile)

export

public void export(@Nullable
                   java.io.File annotationsZip,
                   @Nullable
                   java.io.File proguardCfg)
            throws java.io.IOException

Throws:

java.io.IOException

writeStats

public void writeStats()

mergeExisting

public void mergeExisting(@NonNull
                          java.io.File file)

setListIgnored

public void setListIgnored(boolean listIgnored)

isListIgnored

public boolean isListIgnored()

createData

public com.android.tools.lint.annotations.Extractor.AnnotationData createData(@NonNull
                                                                              java.lang.String name,
                                                                              @NonNull
                                                                              org.jetbrains.uast.UAnnotation annotation)

isHiddenTypeDef

public static boolean isHiddenTypeDef(@NonNull
                                      org.jetbrains.uast.UClass declaration)

Returns true if this type declaration for a typedef is hidden (e.g. should not be extracted into an external annotation database)

Parameters:

declaration - the type declaration

Returns:

true if the type is hidden