Library (Android Builder Model library)

```
public interface Library
```
Represent a variant/module/artifact dependency.

Since:

2.3

Field Summary

Fields
Modifier and Type Field and Description

static int LIBRARY_ANDROID

static int LIBRARY_JAVA

static int LIBRARY_MODULE

Fields
Modifier and Type	Field and Description
`static int`	`LIBRARY_ANDROID`
`static int`	`LIBRARY_JAVA`
`static int`	`LIBRARY_MODULE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAidlFolder()` Returns the location of the aidl import folder.
`java.io.File`	`getArtifact()` Returns the artifact location.
`java.lang.String`	`getArtifactAddress()` Returns the artifact address in a unique way.
`java.lang.String`	`getAssetsFolder()` Returns the location of the assets folder.
`java.lang.String`	`getBuildId()` Returns the build id.
`java.lang.String`	`getCompileJarFile()` Returns the location of the jar file to use for compilation.
`java.lang.String`	`getExternalAnnotations()` Returns the location of the external annotations zip file (which may not exist) Only valid for Android Library where `getType()` is `LIBRARY_ANDROID`
`java.io.File`	`getFolder()` Returns the location of the unzipped bundle folder.
`java.lang.String`	`getJarFile()` Returns the location of the jar file to use for compiling and packaging.
`java.lang.String`	`getJniFolder()` Returns the location of the jni libraries folder.
`java.lang.String`	`getLintJar()` Returns the location of the lint jar.
`java.util.Collection<java.lang.String>`	`getLocalJars()` Returns the list of local Jar files that are included in the dependency.
`java.lang.String`	`getManifest()` Returns the location of the manifest relative to the folder.
`java.lang.String`	`getProguardRules()` Returns the location of the proguard files.
`java.lang.String`	`getProjectPath()` Returns the gradle path.
`java.lang.String`	`getPublicResources()` Returns the location of an optional file that lists the only resources that should be considered public.
`java.lang.String`	`getRenderscriptFolder()` Returns the location of the renderscript import folder.
`java.lang.String`	`getResFolder()` Returns the location of the res folder.
`java.io.File`	`getResStaticLibrary()` Returns the location of the namespaced resources static library (res.apk).
`java.lang.String`	`getSymbolFile()` Returns the location of the text symbol file Only valid for Android Library where `getType()` is `LIBRARY_ANDROID`
`int`	`getType()` The type of the dependency
`java.lang.String`	`getVariant()` Returns an optional variant name if the consumed artifact of the library is associated to one.

- Field Detail
  - LIBRARY_ANDROID
```
static final int LIBRARY_ANDROID
```
    See Also:
    
    Constant Field Values
  - LIBRARY_JAVA
```
static final int LIBRARY_JAVA
```
    See Also:
    
    Constant Field Values
  - LIBRARY_MODULE
```
static final int LIBRARY_MODULE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getType
```
int getType()
```
    The type of the dependency
    
    Returns:
    
    the type
    
    See Also:
    
    LIBRARY_ANDROID, LIBRARY_JAVA, LIBRARY_MODULE
  - getArtifactAddress
```
@NonNull
java.lang.String getArtifactAddress()
```
    Returns the artifact address in a unique way. This is either a module path for sub-modules (with optional variant name), or a maven coordinate for external dependencies.
  - getArtifact
```
@NonNull
java.io.File getArtifact()
```
    Returns the artifact location.
  - getBuildId
```
@Nullable
java.lang.String getBuildId()
```
    Returns the build id.
    This is only valid if the getProjectPath() is not null. However this can still be null if this is the root project.
    
    Returns:
    
    the build id or null.
  - getProjectPath
```
@Nullable
java.lang.String getProjectPath()
```
    Returns the gradle path. Only valid for Android Library where getType() is LIBRARY_MODULE
  - getVariant
```
@Nullable
java.lang.String getVariant()
```
    Returns an optional variant name if the consumed artifact of the library is associated to one. Only valid for Android Library where getType() is LIBRARY_MODULE
  - getFolder
```
@NonNull
java.io.File getFolder()
```
    Returns the location of the unzipped bundle folder. Only valid for Android Library where getType() is LIBRARY_ANDROID
  - getManifest
```
@NonNull
java.lang.String getManifest()
```
    Returns the location of the manifest relative to the folder. Only valid for Android Library where getType() is LIBRARY_ANDROID
  - getJarFile
```
@NonNull
java.lang.String getJarFile()
```
    Returns the location of the jar file to use for compiling and packaging.
    Only valid for Android Library where getType() is LIBRARY_ANDROID.
    
    Returns:
    
    the path to the jar file. The path may not point to an existing file.
  - getCompileJarFile
```
@NonNull
java.lang.String getCompileJarFile()
```
    Returns the location of the jar file to use for compilation.
    Only valid for Android Library where getType() is LIBRARY_ANDROID.
    
    Returns:
    
    path to the jar file used for compilation. The path may not point to an existing file.
  - getResFolder
```
@NonNull
java.lang.String getResFolder()
```
    Returns the location of the res folder. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the res folder. The file may not point to an existing folder.
  - getResStaticLibrary
```
@Nullable
java.io.File getResStaticLibrary()
```
    Returns the location of the namespaced resources static library (res.apk).
    Only valid for Android Library where getType() is LIBRARY_ANDROID
    TODO(b/109854607): When rewriting dependencies, this should be populated with the rewritten artifact, which will not be in the exploded AAR directory.
    
    Returns:
    
    the static library apk. Null if the library is not namespaced.
  - getAssetsFolder
```
@NonNull
java.lang.String getAssetsFolder()
```
    Returns the location of the assets folder.
    Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the assets folder. The file may not point to an existing folder.
  - getLocalJars
```
@NonNull
java.util.Collection<java.lang.String> getLocalJars()
```
    Returns the list of local Jar files that are included in the dependency. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a list of File. May be empty but not null.
  - getJniFolder
```
@NonNull
java.lang.String getJniFolder()
```
    Returns the location of the jni libraries folder. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the folder. The file may not point to an existing folder.
  - getAidlFolder
```
@NonNull
java.lang.String getAidlFolder()
```
    Returns the location of the aidl import folder. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the folder. The file may not point to an existing folder.
  - getRenderscriptFolder
```
@NonNull
java.lang.String getRenderscriptFolder()
```
    Returns the location of the renderscript import folder. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the folder. The file may not point to an existing folder.
  - getProguardRules
```
@NonNull
java.lang.String getProguardRules()
```
    Returns the location of the proguard files. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the file. The file may not point to an existing file.
  - getLintJar
```
@NonNull
java.lang.String getLintJar()
```
    Returns the location of the lint jar. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the jar file. The file may not point to an existing file.
  - getExternalAnnotations
```
@NonNull
java.lang.String getExternalAnnotations()
```
    Returns the location of the external annotations zip file (which may not exist) Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the zip file. The file may not point to an existing file.
  - getPublicResources
```
@NonNull
java.lang.String getPublicResources()
```
    Returns the location of an optional file that lists the only resources that should be considered public. Only valid for Android Library where getType() is LIBRARY_ANDROID
    
    Returns:
    
    a File for the file. The file may not point to an existing file.
  - getSymbolFile
```
@NonNull
java.lang.String getSymbolFile()
```
    Returns the location of the text symbol file Only valid for Android Library where getType() is LIBRARY_ANDROID

Interface Library

Field Summary

Method Summary

Field Detail

LIBRARY_ANDROID

LIBRARY_JAVA

LIBRARY_MODULE

Method Detail

getType

getArtifactAddress

getArtifact

getBuildId

getProjectPath

getVariant

getFolder

getManifest

getJarFile

getCompileJarFile

getResFolder

getResStaticLibrary

getAssetsFolder

getLocalJars

getJniFolder

getAidlFolder

getRenderscriptFolder

getProguardRules

getLintJar

getExternalAnnotations

getPublicResources

getSymbolFile