IAndroidTarget (Android Tools sdklib)

All Superinterfaces:

java.lang.Comparable<IAndroidTarget>

All Known Implementing Classes:

AddonTarget, PlatformTarget
```
public interface IAndroidTarget
extends java.lang.Comparable<IAndroidTarget>
```
A version of Android that applications can target when building.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIONS_ACTIVITY` OS path to the "data/activity_actions.txt" file.
`static int`	`ACTIONS_BROADCAST` OS path to the "data/broadcast_actions.txt" file.
`static int`	`ACTIONS_SERVICE` OS path to the "data/service_actions.txt" file.
`static int`	`ANDROID_AIDL` OS path to the "framework.aidl" file.
`static int`	`ANDROID_JAR` OS path to the "android.jar" file.
`static int`	`ANT` OS path to the "ant" folder which contains the ant build rules (ver 2 and above)
`static int`	`ATTRIBUTES` OS path to the "attrs.xml" file.
`static int`	`CATEGORIES` OS path to the "data/categories.txt" file.
`static int`	`DATA` OS path to the "data" folder which contains data and libraries for the SDK tools.
`static int`	`DOCS` OS path to the target specific docs
`static int`	`FONTS` OS path to the "data/fonts" folder.
`static int`	`LAYOUT_LIB` OS path to the "data/layoutlib.jar" library.
`static int`	`MANIFEST_ATTRIBUTES` OS path to the "attrs_manifest.xml" file.
`static int`	`RESOURCES` OS path to the "data/res" folder.
`static int`	`SAMPLES` OS path to the "samples" folder which contains sample projects.
`static int`	`SKINS` OS path to the "skins" folder which contains the emulator skins.
`static int`	`SOURCES` OS path to the "sources" folder.
`static int`	`TEMPLATES` OS path to the "templates" folder which contains the templates for new projects.
`static int`	`UI_AUTOMATOR_JAR` OS path to the "uiautomator.jar" file.
`static int`	`WIDGETS` OS path to the "data/widgets.txt" file.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`canRunOn(IAndroidTarget target)` Returns whether the given target is compatible with the receiver.
`java.util.List<OptionalLibrary>`	`getAdditionalLibraries()` Returns the additional libraries for this target.
`java.util.List<java.lang.String>`	`getBootClasspath()` Returns the boot classpath for this target.
`BuildToolInfo`	`getBuildToolInfo()` Returns a BuildToolInfo for backward compatibility.
`java.lang.String`	`getClasspathName()` Returns the name to be displayed when representing all the libraries this target contains.
`java.io.File`	`getDefaultSkin()` Returns the default skin folder for this target.
`java.lang.String`	`getDescription()` Returns the description of the target.
`default java.io.File`	`getFile(int pathId)` Returns the path of a platform component.
`java.lang.String`	`getFullName()` Returns the full name of the target, possibly including vendor name.
`java.lang.String`	`getLocation()` Returns the target location.
`java.lang.String`	`getName()` Returns the name of the target.
`java.util.List<OptionalLibrary>`	`getOptionalLibraries()` Returns a list of optional libraries for this target.
`IAndroidTarget`	`getParent()` Returns the parent target.
`java.lang.String`	`getPath(int pathId)` Returns the path of a platform component.
`java.lang.String[]`	`getPlatformLibraries()` Returns the list of libraries available for a given platform.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns all the properties associated with this target.
`java.lang.String`	`getProperty(java.lang.String name)` Return the value of a given property for this target.
`int`	`getRevision()` Returns the revision number for the target.
`java.lang.String`	`getShortClasspathName()` Returns the name to be displayed when representing all the libraries this target contains.
`java.io.File[]`	`getSkins()` Returns the available skin folders for this target.
`java.lang.String`	`getVendor()` Returns the name of the vendor of the target.
`com.android.sdklib.AndroidVersion`	`getVersion()` Returns the version of the target.
`java.lang.String`	`getVersionName()` Returns the platform version as a readable string.
`java.lang.String`	`hashString()` Returns a string able to uniquely identify a target.
`boolean`	`hasRenderingLibrary()` Returns whether the target is able to render layouts.
`boolean`	`isPlatform()` Returns true if the target is a standard Android platform.

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - ANDROID_JAR
```
static final int ANDROID_JAR
```
    OS path to the "android.jar" file.
    
    See Also:
    
    Constant Field Values
  - ANDROID_AIDL
```
static final int ANDROID_AIDL
```
    OS path to the "framework.aidl" file.
    
    See Also:
    
    Constant Field Values
  - SAMPLES
```
static final int SAMPLES
```
    OS path to the "samples" folder which contains sample projects.
    
    See Also:
    
    Constant Field Values
  - SKINS
```
static final int SKINS
```
    OS path to the "skins" folder which contains the emulator skins.
    
    See Also:
    
    Constant Field Values
  - TEMPLATES
```
static final int TEMPLATES
```
    OS path to the "templates" folder which contains the templates for new projects.
    
    See Also:
    
    Constant Field Values
  - DATA
```
static final int DATA
```
    OS path to the "data" folder which contains data and libraries for the SDK tools.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTES
```
static final int ATTRIBUTES
```
    OS path to the "attrs.xml" file.
    
    See Also:
    
    Constant Field Values
  - MANIFEST_ATTRIBUTES
```
static final int MANIFEST_ATTRIBUTES
```
    OS path to the "attrs_manifest.xml" file.
    
    See Also:
    
    Constant Field Values
  - LAYOUT_LIB
```
static final int LAYOUT_LIB
```
    OS path to the "data/layoutlib.jar" library.
    
    See Also:
    
    Constant Field Values
  - RESOURCES
```
static final int RESOURCES
```
    OS path to the "data/res" folder.
    
    See Also:
    
    Constant Field Values
  - FONTS
```
static final int FONTS
```
    OS path to the "data/fonts" folder.
    
    See Also:
    
    Constant Field Values
  - WIDGETS
```
static final int WIDGETS
```
    OS path to the "data/widgets.txt" file.
    
    See Also:
    
    Constant Field Values
  - ACTIONS_ACTIVITY
```
static final int ACTIONS_ACTIVITY
```
    OS path to the "data/activity_actions.txt" file.
    
    See Also:
    
    Constant Field Values
  - ACTIONS_BROADCAST
```
static final int ACTIONS_BROADCAST
```
    OS path to the "data/broadcast_actions.txt" file.
    
    See Also:
    
    Constant Field Values
  - ACTIONS_SERVICE
```
static final int ACTIONS_SERVICE
```
    OS path to the "data/service_actions.txt" file.
    
    See Also:
    
    Constant Field Values
  - CATEGORIES
```
static final int CATEGORIES
```
    OS path to the "data/categories.txt" file.
    
    See Also:
    
    Constant Field Values
  - SOURCES
```
static final int SOURCES
```
    OS path to the "sources" folder.
    
    See Also:
    
    Constant Field Values
  - DOCS
```
static final int DOCS
```
    OS path to the target specific docs
    
    See Also:
    
    Constant Field Values
  - ANT
```
static final int ANT
```
    OS path to the "ant" folder which contains the ant build rules (ver 2 and above)
    
    See Also:
    
    Constant Field Values
  - UI_AUTOMATOR_JAR
```
static final int UI_AUTOMATOR_JAR
```
    OS path to the "uiautomator.jar" file.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLocation
```
@NonNull
java.lang.String getLocation()
```
    Returns the target location.
  - getVendor
```
java.lang.String getVendor()
```
    Returns the name of the vendor of the target.
  - getName
```
java.lang.String getName()
```
    Returns the name of the target.
  - getFullName
```
java.lang.String getFullName()
```
    Returns the full name of the target, possibly including vendor name.
  - getClasspathName
```
java.lang.String getClasspathName()
```
    Returns the name to be displayed when representing all the libraries this target contains.
  - getShortClasspathName
```
java.lang.String getShortClasspathName()
```
    Returns the name to be displayed when representing all the libraries this target contains.
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description of the target.
  - getVersion
```
@NonNull
com.android.sdklib.AndroidVersion getVersion()
```
    Returns the version of the target. This is guaranteed to be non-null.
  - getVersionName
```
java.lang.String getVersionName()
```
    Returns the platform version as a readable string.
  - getRevision
```
int getRevision()
```
    Returns the revision number for the target.
  - isPlatform
```
boolean isPlatform()
```
    Returns true if the target is a standard Android platform.
  - getParent
```
@Nullable
IAndroidTarget getParent()
```
    Returns the parent target. This is likely to only be non null if isPlatform() returns false
  - getPath
```
@NonNull
java.lang.String getPath(int pathId)
```
    Returns the path of a platform component.
    
    Parameters:
    
    pathId - the id representing the path to return. Any of the constants defined in the IAndroidTarget interface can be used.
  - getFile
```
@NonNull
default java.io.File getFile(int pathId)
```
    Returns the path of a platform component.
    This is like the legacy getPath(int) method except it returns a File.
    
    Parameters:
    
    pathId - the id representing the path to return. Any of the constants defined in the IAndroidTarget interface can be used.
  - getBuildToolInfo
```
@Nullable
BuildToolInfo getBuildToolInfo()
```
    Returns a BuildToolInfo for backward compatibility. If an older SDK is used this will return paths located in the platform-tools, otherwise it'll return paths located in the latest build-tools.
    
    Returns:
    
    a BuildToolInfo or null if none are available.
  - getBootClasspath
```
@NonNull
java.util.List<java.lang.String> getBootClasspath()
```
    Returns the boot classpath for this target. In most case, this is similar to calling getPath(int) with ANDROID_JAR.
    
    Returns:
    
    a non null list of the boot classpath.
  - getOptionalLibraries
```
@NonNull
java.util.List<OptionalLibrary> getOptionalLibraries()
```
    Returns a list of optional libraries for this target.
    These libraries are not automatically added to the classpath. Using them requires adding a uses-library entry in the manifest and calling useLibrary in the Gradle build script. Example of such library is org.apache.http.legacy which is not on the classpath by default since 6.0.
    
    Returns:
    
    a list of libraries.
    
    See Also:
    
    OptionalLibrary.getName()
  - getAdditionalLibraries
```
@NonNull
java.util.List<OptionalLibrary> getAdditionalLibraries()
```
    Returns the additional libraries for this target.
    These libraries are automatically added to the classpath, but using them requires adding a uses-library entry in the manifest. Example of such library is com.google.android.maps, which is part of the Google APIs add-on.
    
    Returns:
    
    a list of libraries.
    
    See Also:
    
    OptionalLibrary.getName()
  - hasRenderingLibrary
```
boolean hasRenderingLibrary()
```
    Returns whether the target is able to render layouts.
  - getSkins
```
@NonNull
java.io.File[] getSkins()
```
    Returns the available skin folders for this target.
    To get the skin names, use File.getName().
    Skins come either from:
    - a platform (sdk/platforms/N/skins/name)
    - an add-on (sdk/addons/name/skins/name)
    - a tagged system-image (sdk/system-images/platform-N/tag/abi/skins/name.)
    The array can be empty but not null.
  - getDefaultSkin
```
@Nullable
java.io.File getDefaultSkin()
```
    Returns the default skin folder for this target.
    To get the skin name, use File.getName().
  - getPlatformLibraries
```
java.lang.String[] getPlatformLibraries()
```
    Returns the list of libraries available for a given platform.
    
    Returns:
    
    an array of libraries provided by the platform or null if there is none.
  - getProperty
```
java.lang.String getProperty(java.lang.String name)
```
    Return the value of a given property for this target.
    
    Returns:
    
    the property value or null if it was not found.
  - getProperties
```
java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Returns all the properties associated with this target. This can be null if the target has no properties.
  - canRunOn
```
boolean canRunOn(IAndroidTarget target)
```
    Returns whether the given target is compatible with the receiver.
    This means that a project using the receiver's target can run on the given target.
    Example:
```
 CupcakeTarget.canRunOn(DonutTarget) == true
 
```
    .
    Parameters:
    
    target - the IAndroidTarget to test.
  - hashString
```
java.lang.String hashString()
```
    Returns a string able to uniquely identify a target. Typically the target will encode information such as api level, whether it's a platform or add-on, and if it's an add-on vendor and add-on name.
    See AndroidTargetHash for helper methods to manipulate hash strings.

Interface IAndroidTarget

Field Summary

Method Summary

Methods inherited from interface java.lang.Comparable

Field Detail

ANDROID_JAR

ANDROID_AIDL

SAMPLES

SKINS

TEMPLATES

DATA

ATTRIBUTES

MANIFEST_ATTRIBUTES

LAYOUT_LIB

RESOURCES

FONTS

WIDGETS

ACTIONS_ACTIVITY

ACTIONS_BROADCAST

ACTIONS_SERVICE

CATEGORIES

SOURCES

DOCS

ANT

UI_AUTOMATOR_JAR

Method Detail

getLocation

getVendor

getName

getFullName

getClasspathName

getShortClasspathName

getDescription

getVersion

getVersionName

getRevision

isPlatform

getParent

getPath

getFile

getBuildToolInfo

getBootClasspath

getOptionalLibraries

getAdditionalLibraries

hasRenderingLibrary

getSkins

getDefaultSkin

getPlatformLibraries

getProperty

getProperties

canRunOn

hashString