com.android.ide.common.repository

Enum SdkMavenRepository

java.lang.Object

java.lang.Enum<SdkMavenRepository>

com.android.ide.common.repository.SdkMavenRepository

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SdkMavenRepository>

public enum SdkMavenRepository
extends java.lang.Enum<SdkMavenRepository>

A SdkMavenRepository represents a Maven repository that is shipped with the SDK and located in the extras folder of the SDK location.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANDROID The Android repository; contains support lib, app compat, media router, etc
GOOGLE The Google repository; contains Play Services etc

Method Summary

Modifier and Type	Method and Description
static SdkMavenRepository	find(java.io.File sdkLocation, java.lang.String groupId, java.lang.String artifactId, com.android.repository.io.FileOp fileOp) Returns the SDK repository which contains the given artifact, of null if a matching directory cannot be found in any SDK directory.
static com.android.repository.api.RepoPackage	findBestPackageMatching(GradleCoordinate coordinate, java.util.Collection<? extends com.android.repository.api.RepoPackage> packages) Given a collection of RepoPackages, find the one that best matches the given GradleCoordinate (that is, the one that corresponds to the maven artifact with the same version, or the highest package matching a coordinate with +).
static com.android.repository.api.LocalPackage	findLatestLocalVersion(GradleCoordinate coordinate, com.android.sdklib.repository.AndroidSdkHandler sdkHandler, com.android.repository.api.ProgressIndicator progress) Finds the latest installed version of the SDK package identified by the given GradleCoordinate.
static com.android.repository.api.RemotePackage	findLatestRemoteVersion(GradleCoordinate coordinate, com.android.sdklib.repository.AndroidSdkHandler sdkHandler, com.android.repository.api.ProgressIndicator progress) Like findLatestLocalVersion(GradleCoordinate, AndroidSdkHandler, ProgressIndicator), but for available RemotePackages.
static com.android.repository.api.RepoPackage	findLatestVersion(GradleCoordinate coordinate, com.android.sdklib.repository.AndroidSdkHandler sdkHandler, com.android.repository.api.ProgressIndicator progress) Like findLatestLocalVersion(GradleCoordinate, AndroidSdkHandler, ProgressIndicator), but returns the most recent package available either locally or remotely.
static GradleCoordinate	getCoordinateFromSdkPath(java.lang.String path) Given RepoPackage-style path, get the GradleCoordinate for the package (assuming it is a maven-style package).
java.lang.String	getDirName() The directory name of the repository inside the extras folder
GradleCoordinate	getHighestInstalledVersion(java.io.File sdkHome, java.lang.String groupId, java.lang.String artifactId, java.lang.String filter, boolean allowPreview) Deprecated. For testability use getHighestInstalledVersion(File, String, String, String, boolean, FileOp)
GradleCoordinate	getHighestInstalledVersion(java.io.File sdkHome, java.lang.String groupId, java.lang.String artifactId, java.lang.String filter, boolean allowPreview, com.android.repository.io.FileOp fileOp) Find the best matching GradleCoordinate
java.lang.String	getPackageId()
java.io.File	getRepositoryLocation(java.io.File sdkHome, boolean requireExists) Deprecated. For testability, use getRepositoryLocation(File, boolean, FileOp).
java.io.File	getRepositoryLocation(java.io.File sdkHome, boolean requireExists, com.android.repository.io.FileOp fileOp) Returns the location of the repository within a given SDK home
boolean	isInstalled(com.android.sdklib.repository.AndroidSdkHandler sdkHandler) Returns true if the given SDK repository is installed
boolean	isInstalled(java.io.File sdkHome, com.android.repository.io.FileOp fileOp) Returns true if the given SDK repository is installed
static SdkMavenRepository	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SdkMavenRepository[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANDROID

public static final SdkMavenRepository ANDROID

The Android repository; contains support lib, app compat, media router, etc

GOOGLE

public static final SdkMavenRepository GOOGLE

The Google repository; contains Play Services etc

Method Detail

values

public static SdkMavenRepository[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SdkMavenRepository c : SdkMavenRepository.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SdkMavenRepository valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRepositoryLocation

@Deprecated
 @Nullable
public java.io.File getRepositoryLocation(@Nullable
                                                                 java.io.File sdkHome,
                                                                 boolean requireExists)

Deprecated. For testability, use getRepositoryLocation(File, boolean, FileOp).

getRepositoryLocation

@Nullable
public java.io.File getRepositoryLocation(@Nullable
                                                    java.io.File sdkHome,
                                                    boolean requireExists,
                                                    @NonNull
                                                    com.android.repository.io.FileOp fileOp)

Returns the location of the repository within a given SDK home

Parameters:

sdkHome - the SDK home, or null

requireExists - if true, the location will only be returned if it also exists

Returns:

the location of the this repository within a given SDK

isInstalled

public boolean isInstalled(@Nullable
                           java.io.File sdkHome,
                           @NonNull
                           com.android.repository.io.FileOp fileOp)

Returns true if the given SDK repository is installed

Parameters:

sdkHome - the SDK installation location

Returns:

true if the repository is installed

isInstalled

public boolean isInstalled(@Nullable
                           com.android.sdklib.repository.AndroidSdkHandler sdkHandler)

Returns true if the given SDK repository is installed

Parameters:

sdkHandler - the SDK to check

Returns:

true if the repository is installed

getPackageId

public java.lang.String getPackageId()

getHighestInstalledVersion

@Deprecated
public GradleCoordinate getHighestInstalledVersion(@Nullable
                                                               java.io.File sdkHome,
                                                               @NonNull
                                                               java.lang.String groupId,
                                                               @NonNull
                                                               java.lang.String artifactId,
                                                               @Nullable
                                                               java.lang.String filter,
                                                               boolean allowPreview)

Deprecated. For testability use getHighestInstalledVersion(File, String, String, String, boolean, FileOp)

getHighestInstalledVersion

@Nullable
public GradleCoordinate getHighestInstalledVersion(@Nullable
                                                             java.io.File sdkHome,
                                                             @NonNull
                                                             java.lang.String groupId,
                                                             @NonNull
                                                             java.lang.String artifactId,
                                                             @Nullable
                                                             java.lang.String filter,
                                                             boolean allowPreview,
                                                             @NonNull
                                                             com.android.repository.io.FileOp fileOp)

Find the best matching GradleCoordinate

Parameters:

sdkHome - the SDK installation

groupId - the artifact group id

artifactId - the artifact id

filter - an optional filter which the matched coordinate's version name must start with

allowPreview - whether preview versions are allowed to match

fileOp - To allow mocking of filesystem operations.

Returns:

the best (highest version) matching coordinate, or null if none were found

find

@Nullable
public static SdkMavenRepository find(@NonNull
                                                java.io.File sdkLocation,
                                                @NonNull
                                                java.lang.String groupId,
                                                @NonNull
                                                java.lang.String artifactId,
                                                @NonNull
                                                com.android.repository.io.FileOp fileOp)

Returns the SDK repository which contains the given artifact, of null if a matching directory cannot be found in any SDK directory.

getDirName

@NonNull
public java.lang.String getDirName()

The directory name of the repository inside the extras folder

getCoordinateFromSdkPath

@Nullable
public static GradleCoordinate getCoordinateFromSdkPath(@NonNull
                                                                  java.lang.String path)

Given RepoPackage-style path, get the GradleCoordinate for the package (assuming it is a maven-style package).

Returns:

The GradleCoordinate, or null if the package is not a maven-style package.

findBestPackageMatching

@Nullable
public static com.android.repository.api.RepoPackage findBestPackageMatching(@NonNull
                                                                                       GradleCoordinate coordinate,
                                                                                       @NonNull
                                                                                       java.util.Collection<? extends com.android.repository.api.RepoPackage> packages)

Given a collection of RepoPackages, find the one that best matches the given GradleCoordinate (that is, the one that corresponds to the maven artifact with the same version, or the highest package matching a coordinate with +).

Returns:

The best package, or null if none was found.

findLatestLocalVersion

@Nullable
public static com.android.repository.api.LocalPackage findLatestLocalVersion(@NonNull
                                                                                       GradleCoordinate coordinate,
                                                                                       @NonNull
                                                                                       com.android.sdklib.repository.AndroidSdkHandler sdkHandler,
                                                                                       @NonNull
                                                                                       com.android.repository.api.ProgressIndicator progress)

Finds the latest installed version of the SDK package identified by the given GradleCoordinate. Preview versions will only be included if the given coordinate is a preview. E.g. if coordinate is com.android.support.constraint:constraint-layout:1.0.0 and com.android.support.constraint:constraint-layout:1.1.0 and com.android.support.constraint:constraint-layout:1.2.0-alpha1 are also installed, the SDK package extras;m2repository;com;android;support;constraint;constraint-layout;1.1.0 will be returned, since the provided coordinate is not a preview. If com.android.support.constraint:constraint-layout:1.0.0-alpha1 is passed in, extras;m2repository;com;android;support;constraint;constraint-layout;1.1.0-alpha1 will be returned.

Parameters:

coordinate - The GradleCoordinate identifying the artifact we're interested in.

sdkHandler - AndroidSdkHandler instance.

progress - ProgressIndicator, for logging.

Returns:

The LocalPackage with the same groupId and artifactId as the given coordinate and the highest version.

findLatestRemoteVersion

@Nullable
public static com.android.repository.api.RemotePackage findLatestRemoteVersion(@NonNull
                                                                                         GradleCoordinate coordinate,
                                                                                         @NonNull
                                                                                         com.android.sdklib.repository.AndroidSdkHandler sdkHandler,
                                                                                         @NonNull
                                                                                         com.android.repository.api.ProgressIndicator progress)

Like findLatestLocalVersion(GradleCoordinate, AndroidSdkHandler, ProgressIndicator), but for available RemotePackages.

findLatestVersion

@Nullable
public static com.android.repository.api.RepoPackage findLatestVersion(@NonNull
                                                                                 GradleCoordinate coordinate,
                                                                                 @NonNull
                                                                                 com.android.sdklib.repository.AndroidSdkHandler sdkHandler,
                                                                                 @NonNull
                                                                                 com.android.repository.api.ProgressIndicator progress)

Like findLatestLocalVersion(GradleCoordinate, AndroidSdkHandler, ProgressIndicator), but returns the most recent package available either locally or remotely.