com.android.ide.common.build

Class ApkData

java.lang.Object

com.android.ide.common.build.ApkData

All Implemented Interfaces:

com.android.build.VariantOutput, ApkInfo, java.io.Serializable

public abstract class ApkData
extends java.lang.Object
implements ApkInfo, com.android.build.VariantOutput

FIX ME : wrong name but convenient until I can clean up existing classes/namespace.

This split represents a Variant output, which can be a main (base) split, a full split, a configuration pure splits. Each variant has one to many of such outputs depending on its configuration.

this is used to model outputs of a variant during configuration and it is sometimes altered at execution when new pure splits are discovered.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.android.ide.common.build.ApkInfo

ApkInfo.DefaultApkInfo

Nested classes/interfaces inherited from interface com.android.build.VariantOutput

com.android.build.VariantOutput.FilterType, com.android.build.VariantOutput.OutputType

Field Summary

Fields inherited from interface com.android.build.VariantOutput

ABI, DENSITY, FULL_SPLIT, LANGUAGE, MAIN, NO_FILTER, SPLIT

Constructor Summary

Constructors

Constructor and Description
ApkData()

Method Summary

Modifier and Type	Method and Description
void	disable()
boolean	equals(java.lang.Object o)
abstract java.lang.String	getBaseName()
abstract java.lang.String	getDirName() Returns a directory name relative to a variant specific location to save split specific output files or null to use the variant specific folder.
static java.lang.String	getFilter(java.util.Collection<com.android.build.FilterData> filters, com.android.build.VariantOutput.FilterType filterType)
java.lang.String	getFilter(java.lang.String filterType)
com.android.build.FilterData	getFilter(com.android.build.VariantOutput.FilterType filterType)
java.util.Collection<com.android.build.FilterData>	getFilters() Returns all the split information used to create the APK.
java.util.Collection<java.lang.String>	getFilterTypes()
abstract java.lang.String	getFullName()
com.android.build.OutputFile	getMainOutputFile()
java.lang.String	getOutputFileName()
java.util.Collection<? extends com.android.build.OutputFile>	getOutputs()
java.lang.String	getOutputType()
abstract com.android.build.VariantOutput.OutputType	getType() Returns the output type of the referenced APK.
int	getVersionCode() Returns the version code for this output.
java.lang.String	getVersionName()
int	hashCode()
boolean	isEnabled()
boolean	requiresAapt()
void	setOutputFileName(java.lang.String outputFileName)
void	setVersionCode(int versionCode)
void	setVersionName(java.lang.String versionName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.android.ide.common.build.ApkInfo

getFilterName, of, of

Constructor Detail

ApkData

public ApkData()

Method Detail

getFilters

@NonNull
public java.util.Collection<com.android.build.FilterData> getFilters()

Description copied from interface: ApkInfo

Returns all the split information used to create the APK.

Specified by:

getFilters in interface com.android.build.VariantOutput

Specified by:

getFilters in interface ApkInfo

getFilterTypes

@NonNull
public java.util.Collection<java.lang.String> getFilterTypes()

Specified by:

getFilterTypes in interface com.android.build.VariantOutput

getFilter

@Nullable
public com.android.build.FilterData getFilter(com.android.build.VariantOutput.FilterType filterType)

Specified by:

getFilter in interface ApkInfo

getFilter

@Nullable
public java.lang.String getFilter(java.lang.String filterType)

requiresAapt

public boolean requiresAapt()

Specified by:

requiresAapt in interface ApkInfo

getBaseName

@NonNull
public abstract java.lang.String getBaseName()

Specified by:

getBaseName in interface ApkInfo

getFullName

@NonNull
public abstract java.lang.String getFullName()

Specified by:

getFullName in interface ApkInfo

getType

@NonNull
public abstract com.android.build.VariantOutput.OutputType getType()

Description copied from interface: ApkInfo

Returns the output type of the referenced APK.

Specified by:

getType in interface ApkInfo

getDirName

@NonNull
public abstract java.lang.String getDirName()

Returns a directory name relative to a variant specific location to save split specific output files or null to use the variant specific folder.

Returns:

a directory name of null.

setVersionCode

public void setVersionCode(int versionCode)

setVersionName

public void setVersionName(java.lang.String versionName)

setOutputFileName

public void setOutputFileName(@NonNull
                              java.lang.String outputFileName)

getVersionCode

public int getVersionCode()

Description copied from interface: ApkInfo

Returns the version code for this output.

This is convenient method that returns the final version code whether it's coming from the override set in the output or from the variant's merged flavor.

Specified by:

getVersionCode in interface com.android.build.VariantOutput

Specified by:

getVersionCode in interface ApkInfo

Returns:

the version code.

getVersionName

@Nullable
public java.lang.String getVersionName()

Specified by:

getVersionName in interface ApkInfo

getOutputFileName

@Nullable
public java.lang.String getOutputFileName()

Specified by:

getOutputFileName in interface ApkInfo

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMainOutputFile

@NonNull
public com.android.build.OutputFile getMainOutputFile()

Specified by:

getMainOutputFile in interface com.android.build.VariantOutput

getOutputs

@NonNull
public java.util.Collection<? extends com.android.build.OutputFile> getOutputs()

Specified by:

getOutputs in interface com.android.build.VariantOutput

getOutputType

@NonNull
public java.lang.String getOutputType()

Specified by:

getOutputType in interface com.android.build.VariantOutput

getFilter

@Nullable
public static java.lang.String getFilter(java.util.Collection<com.android.build.FilterData> filters,
                                                   com.android.build.VariantOutput.FilterType filterType)

disable

public void disable()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ApkInfo

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object