com.android.builder.sdk

Interface SdkLoader

All Known Implementing Classes:

DefaultSdkLoader, PlatformLoader

public interface SdkLoader

A loader for the SDK. It's able to provide general SDK information (getSdkInfo(com.android.utils.ILogger), or getRepositories()), or target-specific information (getTargetInfo(String, Revision, com.android.utils.ILogger, SdkLibData)).

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<java.io.File>	getRepositories() Returns the location of artifact repositories built-in the SDK.
SdkInfo	getSdkInfo(com.android.utils.ILogger logger) Returns generic SDK information.
TargetInfo	getTargetInfo(java.lang.String targetHash, com.android.repository.Revision buildToolRevision, com.android.utils.ILogger logger, SdkLibData sdkLibData) Returns information about a build target.
java.io.File	installSdkTool(SdkLibData sdkLibData, java.lang.String packageId) Installs an Android Sdk Tool if it's not already installed.
java.util.List<java.io.File>	updateRepositories(java.util.List<java.lang.String> repositoryPaths, SdkLibData sdkLibData, com.android.utils.ILogger logger) Tries to update (or install) all local maven repositories and returns a list of directories that were modified.

Method Detail

getTargetInfo

@NonNull
TargetInfo getTargetInfo(@NonNull
                                  java.lang.String targetHash,
                                  @NonNull
                                  com.android.repository.Revision buildToolRevision,
                                  @NonNull
                                  com.android.utils.ILogger logger,
                                  @NonNull
                                  SdkLibData sdkLibData)
                           throws LicenceNotAcceptedException,
                                  InstallFailedException

Returns information about a build target. Potentially downloads SDK components if sdkLibData.useSdlDownload() is true. This requires loading/parsing the SDK.

Parameters:

targetHash - the compilation target hash string.

buildToolRevision - the build tools revision.

logger - a logger to output messages.

sdkLibData - a wrapper containing all the components for downloading.

Returns:

the target info.

Throws:

LicenceNotAcceptedException

InstallFailedException

getSdkInfo

@NonNull
SdkInfo getSdkInfo(@NonNull
                            com.android.utils.ILogger logger)

Returns generic SDK information. This requires loading/parsing the SDK.

Parameters:

logger - a logger to output messages.

Returns:

the sdk info.

getRepositories

@NonNull
com.google.common.collect.ImmutableList<java.io.File> getRepositories()

Returns the location of artifact repositories built-in the SDK.

Returns:

a non null list of repository folders.

updateRepositories

@NonNull
java.util.List<java.io.File> updateRepositories(@NonNull
                                                         java.util.List<java.lang.String> repositoryPaths,
                                                         @NonNull
                                                         SdkLibData sdkLibData,
                                                         @NonNull
                                                         com.android.utils.ILogger logger)
                                                  throws LicenceNotAcceptedException,
                                                         InstallFailedException

Tries to update (or install) all local maven repositories and returns a list of directories that were modified.

Parameters:

repositoryPaths - a list of all install paths as described in RepoPackage of the remote packages for the maven repositories. Eg.: extras;google;m2repository

sdkLibData - contains all the components for downloading.

logger - a logger for messages.

Returns:

a List of locations to the directories that contain the maven repositories.

Throws:

LicenceNotAcceptedException

InstallFailedException

installSdkTool

@Nullable
java.io.File installSdkTool(@NonNull
                                      SdkLibData sdkLibData,
                                      @NonNull
                                      java.lang.String packageId)
                               throws LicenceNotAcceptedException,
                                      InstallFailedException

Installs an Android Sdk Tool if it's not already installed.

Parameters:

sdkLibData - contains all the components for downloading.

packageId - the package/id path of the required Tool component.

Returns:

a File representing the locations to the directory where the Tool component is installed or null if we haven't managed to find such a component.

Throws:

LicenceNotAcceptedException

InstallFailedException