com.android.builder.model

Interface AndroidLibrary

All Superinterfaces:

AndroidBundle, Library

public interface AndroidLibrary
extends AndroidBundle

Represents an Android Library dependency, its content and its own dependencies.

Method Summary

Modifier and Type	Method and Description
java.io.File	getAidlFolder() Returns the location of the aidl import folder.
java.io.File	getExternalAnnotations() Returns the location of the external annotations zip file (which may not exist)
java.io.File	getJniFolder() Returns the location of the jni libraries folder.
java.io.File	getLintJar() Returns the location of the lint jar.
java.util.Collection<java.io.File>	getLocalJars() Returns the list of local Jar files that are included in the dependency.
java.io.File	getProguardRules() Returns the location of the proguard files.
java.io.File	getPublicResources() Returns the location of an optional file that lists the only resources that should be considered public.
java.io.File	getRenderscriptFolder() Returns the location of the renderscript import folder.
java.io.File	getSymbolFile() Returns the location of the text symbol file
boolean	isOptional() Deprecated. Use isProvided() instead
boolean	isProvided() Returns whether the library is considered optional, meaning that it may or may not be present in the final APK.

Methods inherited from interface com.android.builder.model.AndroidBundle

getAssetsFolder, getBundle, getCompileJarFile, getFolder, getJarFile, getJavaDependencies, getLibraryDependencies, getManifest, getProjectVariant, getResFolder, getResStaticLibrary

Methods inherited from interface com.android.builder.model.Library

getBuildId, getName, getProject, getRequestedCoordinates, getResolvedCoordinates, isSkipped

Method Detail

getLocalJars

@NonNull
java.util.Collection<java.io.File> getLocalJars()

Returns the list of local Jar files that are included in the dependency.

Returns:

a list of File. May be empty but not null.

getJniFolder

@NonNull
java.io.File getJniFolder()

Returns the location of the jni libraries folder.

Returns:

a File for the folder. The file may not point to an existing folder.

getAidlFolder

@NonNull
java.io.File getAidlFolder()

Returns the location of the aidl import folder.

Returns:

a File for the folder. The file may not point to an existing folder.

getRenderscriptFolder

@NonNull
java.io.File getRenderscriptFolder()

Returns the location of the renderscript import folder.

Returns:

a File for the folder. The file may not point to an existing folder.

getProguardRules

@NonNull
java.io.File getProguardRules()

Returns the location of the proguard files.

Returns:

a File for the file. The file may not point to an existing file.

getLintJar

@NonNull
java.io.File getLintJar()

Returns the location of the lint jar.

Returns:

a File for the jar file. The file may not point to an existing file.

getExternalAnnotations

@NonNull
java.io.File getExternalAnnotations()

Returns the location of the external annotations zip file (which may not exist)

Returns:

a File for the zip file. The file may not point to an existing file.

getPublicResources

@NonNull
java.io.File getPublicResources()

Returns the location of an optional file that lists the only resources that should be considered public.

Returns:

a File for the file. The file may not point to an existing file.

getSymbolFile

@NonNull
java.io.File getSymbolFile()

Returns the location of the text symbol file

isProvided

boolean isProvided()

Returns whether the library is considered optional, meaning that it may or may not be present in the final APK. If the library is optional, then: - if the consumer is a library, it'll get skipped from resource merging and won't show up in the consumer R.txt - if the consumer is a separate test project, all the resources gets skipped from merging.

Specified by:

isProvided in interface Library

Returns:

true if provided.

isOptional

@Deprecated
boolean isOptional()

Deprecated. Use isProvided() instead