com.android.tools.build.apkzlib.zfile

Class ApkCreatorFactory.CreationData

java.lang.Object

com.android.tools.build.apkzlib.zfile.ApkCreatorFactory.CreationData

Enclosing interface:

ApkCreatorFactory

public static class ApkCreatorFactory.CreationData
extends java.lang.Object

Data structure with the required information to initiate the creation of an APK. See ApkCreatorFactory.make(CreationData).

Constructor Summary

Constructors

Constructor and Description
CreationData(java.io.File apkPath, java.security.PrivateKey key, java.security.cert.X509Certificate certificate, boolean v1SigningEnabled, boolean v2SigningEnabled, java.lang.String builtBy, java.lang.String createdBy, int minSdkVersion, NativeLibrariesPackagingMode nativeLibrariesPackagingMode, java.util.function.Predicate<java.lang.String> noCompressPredicate)

Method Summary

Modifier and Type	Method and Description
java.io.File	getApkPath() Obtains the path where the APK should be located.
java.lang.String	getBuiltBy() Obtains the "built-by" text for the APK.
java.security.cert.X509Certificate	getCertificate() Obtains the certificate used to sign the APK.
java.lang.String	getCreatedBy() Obtains the "created-by" text for the APK.
int	getMinSdkVersion() Obtains the minimum SDK version to run the APK.
NativeLibrariesPackagingMode	getNativeLibrariesPackagingMode() Returns the packaging policy that the ApkCreator should use for native libraries.
java.util.function.Predicate<java.lang.String>	getNoCompressPredicate() Returns the predicate to decide which file paths should be uncompressed.
java.security.PrivateKey	getPrivateKey() Obtains the private key used to sign the APK.
boolean	isV1SigningEnabled() Returns true if this APK should be signed with JAR Signature Scheme (aka v1 scheme).
boolean	isV2SigningEnabled() Returns true if this APK should be signed with APK Signature Scheme v2 (aka v2 scheme).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreationData

public CreationData(@Nonnull
                    java.io.File apkPath,
                    @Nullable
                    java.security.PrivateKey key,
                    @Nullable
                    java.security.cert.X509Certificate certificate,
                    boolean v1SigningEnabled,
                    boolean v2SigningEnabled,
                    @Nullable
                    java.lang.String builtBy,
                    @Nullable
                    java.lang.String createdBy,
                    int minSdkVersion,
                    @Nonnull
                    NativeLibrariesPackagingMode nativeLibrariesPackagingMode,
                    @Nonnull
                    java.util.function.Predicate<java.lang.String> noCompressPredicate)

Parameters:

apkPath - the path where the APK should be located. May already exist or not (if it does, then the APK may be updated instead of created)

key - key used to sign the APK. May be null

certificate - certificate used to sign the APK. Is null if and only if key is null

v1SigningEnabled - true if this APK should be signed with JAR Signature Scheme (aka v1 scheme).

v2SigningEnabled - true if this APK should be signed with APK Signature Scheme v2 (aka v2 scheme).

builtBy - built-by information for the APK, if any; if null then the default should be used

createdBy - created-by information for the APK, if any; if null then the default should be used

minSdkVersion - minimum SDK version that will run the APK

nativeLibrariesPackagingMode - packaging mode for native libraries

noCompressPredicate - predicate to decide which file paths should be uncompressed; returns true for files that should not be compressed

Method Detail

getApkPath

@Nonnull
public java.io.File getApkPath()

Obtains the path where the APK should be located. If the path already exists, then the APK may be updated instead of re-created.

Returns:

the path that may already exist or not

getPrivateKey

@Nullable
public java.security.PrivateKey getPrivateKey()

Obtains the private key used to sign the APK.

Returns:

the private key or null if the APK should not be signed

getCertificate

@Nullable
public java.security.cert.X509Certificate getCertificate()

Obtains the certificate used to sign the APK.

Returns:

the certificate or null if the APK should not be signed; this will return null if and only if getPrivateKey() returns null

isV1SigningEnabled

public boolean isV1SigningEnabled()

Returns true if this APK should be signed with JAR Signature Scheme (aka v1 scheme).

isV2SigningEnabled

public boolean isV2SigningEnabled()

Returns true if this APK should be signed with APK Signature Scheme v2 (aka v2 scheme).

getBuiltBy

@Nullable
public java.lang.String getBuiltBy()

Obtains the "built-by" text for the APK.

Returns:

the text or null if the default should be used

getCreatedBy

@Nullable
public java.lang.String getCreatedBy()

Obtains the "created-by" text for the APK.

Returns:

the text or null if the default should be used

getMinSdkVersion

public int getMinSdkVersion()

Obtains the minimum SDK version to run the APK.

Returns:

the minimum SDK version

getNativeLibrariesPackagingMode

@Nonnull
public NativeLibrariesPackagingMode getNativeLibrariesPackagingMode()

Returns the packaging policy that the ApkCreator should use for native libraries.

getNoCompressPredicate

@Nonnull
public java.util.function.Predicate<java.lang.String> getNoCompressPredicate()

Returns the predicate to decide which file paths should be uncompressed.