com.android.sdklib.repository.descriptors
Class PkgDesc.Builder

java.lang.Object
  extended by com.android.sdklib.repository.descriptors.PkgDesc.Builder
Enclosing class:
PkgDesc

public static class PkgDesc.Builder
extends java.lang.Object


Method Summary
 IPkgDesc create()
           
static PkgDesc.Builder newAddon(com.android.sdklib.AndroidVersion version, com.android.repository.Revision revision, IdDisplay addonVendor, IdDisplay addonName)
          Create a new add-on package descriptor.
static PkgDesc.Builder newAddonSysImg(com.android.sdklib.AndroidVersion version, IdDisplay addonVendor, IdDisplay addonName, java.lang.String abi, com.android.repository.Revision revision)
          Create a new add-on system-image package descriptor.
static PkgDesc.Builder newBuildTool(com.android.repository.Revision revision)
          Creates a new build-tool package descriptor.
static PkgDesc.Builder newDoc(com.android.sdklib.AndroidVersion version, com.android.repository.Revision revision)
          Creates a new doc package descriptor.
static PkgDesc.Builder newExtra(IdDisplay vendor, java.lang.String path, java.lang.String displayName, java.lang.String[] oldPaths, com.android.repository.Revision revision)
          Creates a new extra package descriptor.
static PkgDesc.Builder newLLDB(com.android.repository.Revision revision)
          Creates a new LLDB package descriptor.
static PkgDesc.Builder newNdk(com.android.repository.Revision revision)
          Creates a new NDK package descriptor.
static PkgDesc.Builder newPlatform(com.android.sdklib.AndroidVersion version, com.android.repository.Revision revision, com.android.repository.Revision minToolsRev)
          Creates a new platform package descriptor.
static PkgDesc.Builder newPlatformTool(com.android.repository.Revision revision)
          Creates a new platform-tool package descriptor.
static PkgDesc.Builder newSample(com.android.sdklib.AndroidVersion version, com.android.repository.Revision revision, com.android.repository.Revision minToolsRev)
          Create a new sample package descriptor.
static PkgDesc.Builder newSource(com.android.sdklib.AndroidVersion version, com.android.repository.Revision revision)
          Create a new source package descriptor.
static PkgDesc.Builder newSysImg(com.android.sdklib.AndroidVersion version, IdDisplay tag, java.lang.String abi, com.android.repository.Revision revision)
          Create a new platform system-image package descriptor.
static PkgDesc.Builder newTool(com.android.repository.Revision revision, com.android.repository.Revision minPlatformToolsRev)
          Creates a new tool package descriptor.
 PkgDesc.Builder setDescriptionShort(java.lang.String text)
           
 PkgDesc.Builder setDescriptionUrl(java.lang.String text)
           
 PkgDesc.Builder setIsObsolete(boolean isObsolete)
           
 PkgDesc.Builder setLicense(com.android.repository.api.License license)
           
 PkgDesc.Builder setListDisplay(java.lang.String text)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

newTool

@NonNull
public static PkgDesc.Builder newTool(@NonNull
                                              com.android.repository.Revision revision,
                                              @NonNull
                                              com.android.repository.Revision minPlatformToolsRev)
Creates a new tool package descriptor.

Parameters:
revision - The revision of the tool package.
minPlatformToolsRev - The min-platform-tools-rev. Use Revision.NOT_SPECIFIED to indicate there is no requirement.
Returns:
A PkgDesc describing this tool package.

newPlatformTool

@NonNull
public static PkgDesc.Builder newPlatformTool(@NonNull
                                                      com.android.repository.Revision revision)
Creates a new platform-tool package descriptor.

Parameters:
revision - The revision of the platform-tool package.
Returns:
A PkgDesc describing this platform-tool package.

newBuildTool

@NonNull
public static PkgDesc.Builder newBuildTool(@NonNull
                                                   com.android.repository.Revision revision)
Creates a new build-tool package descriptor.

Parameters:
revision - The revision of the build-tool package.
Returns:
A PkgDesc describing this build-tool package.

newDoc

@NonNull
public static PkgDesc.Builder newDoc(@NonNull
                                             com.android.sdklib.AndroidVersion version,
                                             @NonNull
                                             com.android.repository.Revision revision)
Creates a new doc package descriptor.

Parameters:
revision - The revision of the doc package.
Returns:
A PkgDesc describing this doc package.

newExtra

@NonNull
public static PkgDesc.Builder newExtra(@NonNull
                                               IdDisplay vendor,
                                               @NonNull
                                               java.lang.String path,
                                               @Nullable
                                               java.lang.String displayName,
                                               @Nullable
                                               java.lang.String[] oldPaths,
                                               @NonNull
                                               com.android.repository.Revision revision)
Creates a new extra package descriptor.

Parameters:
vendor - The vendor id string of the extra package.
path - The path id string of the extra package.
displayName - The display name. If missing, caller should build one using the path.
oldPaths - An optional list of older paths for this extra package.
revision - The revision of the extra package.
Returns:
A PkgDesc describing this extra package.

newPlatform

@NonNull
public static PkgDesc.Builder newPlatform(@NonNull
                                                  com.android.sdklib.AndroidVersion version,
                                                  @NonNull
                                                  com.android.repository.Revision revision,
                                                  @NonNull
                                                  com.android.repository.Revision minToolsRev)
Creates a new platform package descriptor.

Parameters:
version - The android version of the platform package.
revision - The revision of the extra package.
minToolsRev - An optional min-tools-rev. Use Revision.NOT_SPECIFIED to indicate there is no requirement.
Returns:
A PkgDesc describing this platform package.

newAddon

@NonNull
public static PkgDesc.Builder newAddon(@NonNull
                                               com.android.sdklib.AndroidVersion version,
                                               @NonNull
                                               com.android.repository.Revision revision,
                                               @NonNull
                                               IdDisplay addonVendor,
                                               @NonNull
                                               IdDisplay addonName)
Create a new add-on package descriptor.

The vendor id and the name id provided are used to compute the add-on's target hash.

Parameters:
version - The android version of the add-on package.
revision - The revision of the add-on package.
addonVendor - The vendor id/display of the add-on package.
addonName - The name id/display of the add-on package.
Returns:
A PkgDesc describing this add-on package.

newSysImg

@NonNull
public static PkgDesc.Builder newSysImg(@NonNull
                                                com.android.sdklib.AndroidVersion version,
                                                @NonNull
                                                IdDisplay tag,
                                                @NonNull
                                                java.lang.String abi,
                                                @NonNull
                                                com.android.repository.Revision revision)
Create a new platform system-image package descriptor.

For system-images, PkgDesc.getPath() returns the ABI.

Parameters:
version - The android version of the system-image package.
tag - The tag of the system-image package.
abi - The ABI of the system-image package.
revision - The revision of the system-image package.
Returns:
A PkgDesc describing this system-image package.

newAddonSysImg

@NonNull
public static PkgDesc.Builder newAddonSysImg(@NonNull
                                                     com.android.sdklib.AndroidVersion version,
                                                     @NonNull
                                                     IdDisplay addonVendor,
                                                     @NonNull
                                                     IdDisplay addonName,
                                                     @NonNull
                                                     java.lang.String abi,
                                                     @NonNull
                                                     com.android.repository.Revision revision)
Create a new add-on system-image package descriptor.

For system-images, PkgDesc.getPath() returns the ABI.

Parameters:
version - The android version of the system-image package.
addonVendor - The vendor id/display of an associated add-on.
addonName - The tag of the system-image package is the add-on name.
abi - The ABI of the system-image package.
revision - The revision of the system-image package.
Returns:
A PkgDesc describing this system-image package.

newSource

@NonNull
public static PkgDesc.Builder newSource(@NonNull
                                                com.android.sdklib.AndroidVersion version,
                                                @NonNull
                                                com.android.repository.Revision revision)
Create a new source package descriptor.

Parameters:
version - The android version of the source package.
revision - The revision of the source package.
Returns:
A PkgDesc describing this source package.

newSample

@NonNull
public static PkgDesc.Builder newSample(@NonNull
                                                com.android.sdklib.AndroidVersion version,
                                                @NonNull
                                                com.android.repository.Revision revision,
                                                @NonNull
                                                com.android.repository.Revision minToolsRev)
Create a new sample package descriptor.

Parameters:
version - The android version of the sample package.
revision - The revision of the sample package.
minToolsRev - An optional min-tools-rev. Use Revision.NOT_SPECIFIED to indicate there is no requirement.
Returns:
A PkgDesc describing this sample package.

newNdk

@NonNull
public static PkgDesc.Builder newNdk(@NonNull
                                             com.android.repository.Revision revision)
Creates a new NDK package descriptor.

Parameters:
revision - The revision of the NDK package.
Returns:
A PkgDesc describing this NDK package.

newLLDB

@NonNull
public static PkgDesc.Builder newLLDB(@NonNull
                                              com.android.repository.Revision revision)
Creates a new LLDB package descriptor.

Parameters:
revision - The revision of the LLDB package.
Returns:
A PkgDesc describing this LLDB package.

setLicense

public PkgDesc.Builder setLicense(@Nullable
                                  com.android.repository.api.License license)

setListDisplay

public PkgDesc.Builder setListDisplay(@Nullable
                                      java.lang.String text)

setDescriptionShort

public PkgDesc.Builder setDescriptionShort(@Nullable
                                           java.lang.String text)

setDescriptionUrl

public PkgDesc.Builder setDescriptionUrl(@Nullable
                                         java.lang.String text)

setIsObsolete

public PkgDesc.Builder setIsObsolete(boolean isObsolete)

create

public IPkgDesc create()