com.android.builder.core

Class DefaultDexOptions

java.lang.Object

com.android.builder.core.DefaultDexOptions

All Implemented Interfaces:

DexOptions

public class DefaultDexOptions
extends java.lang.Object
implements DexOptions

Concrete implementation of DexOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTIMIZE_WARNING

Constructor Summary

Constructors

Constructor and Description
DefaultDexOptions()

Method Summary

Modifier and Type	Method and Description
static DefaultDexOptions	copyOf(DexOptions dexOptions)
java.util.List<java.lang.String>	getAdditionalParameters() List of additional parameters to be passed to dx.
boolean	getDexInProcess() Whether to run the dx compiler as a separate process or inside the Gradle daemon JVM.
java.lang.String	getJavaMaxHeapSize() Specifies the -Xmx value when calling dx.
boolean	getJumboMode() Enable jumbo mode in dx (--force-jumbo).
boolean	getKeepRuntimeAnnotatedClasses() Keep all classes with runtime annotations in the main dex in legacy multidex.
java.lang.Integer	getMaxProcessCount() Returns the maximum number of concurrent processes that can be used to dex.
java.lang.Boolean	getOptimize() Deprecated. Dex is always optimized. This returns true always.
boolean	getPreDexLibraries() Whether to pre-dex libraries.
java.lang.Integer	getThreadCount() Number of threads to use when running dx.
void	setAdditionalParameters(java.util.List<java.lang.String> additionalParameters)
void	setDexInProcess(boolean dexInProcess)
void	setJavaMaxHeapSize(java.lang.String javaMaxHeapSize)
void	setJumboMode(boolean jumboMode)
void	setKeepRuntimeAnnotatedClasses(boolean keepRuntimeAnnotatedClasses)
void	setMaxProcessCount(java.lang.Integer maxProcessCount)
void	setPreDexLibraries(boolean preDexLibraries)
void	setThreadCount(java.lang.Integer threadCount)

Methods inherited from class java.lang.Object

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

Field Detail

OPTIMIZE_WARNING

public static final java.lang.String OPTIMIZE_WARNING

See Also:

Constant Field Values

Constructor Detail

DefaultDexOptions

public DefaultDexOptions()

Method Detail

copyOf

public static DefaultDexOptions copyOf(DexOptions dexOptions)

getPreDexLibraries

public boolean getPreDexLibraries()

Whether to pre-dex libraries. This can improve incremental builds, but clean builds may be slower.

Specified by:

getPreDexLibraries in interface DexOptions

setPreDexLibraries

public void setPreDexLibraries(boolean preDexLibraries)

getJumboMode

public boolean getJumboMode()

Enable jumbo mode in dx (--force-jumbo).

Specified by:

getJumboMode in interface DexOptions

setJumboMode

public void setJumboMode(boolean jumboMode)

getDexInProcess

public boolean getDexInProcess()

Whether to run the dx compiler as a separate process or inside the Gradle daemon JVM.

Running dx in-process can greatly improve performance, but is still experimental.

Specified by:

getDexInProcess in interface DexOptions

setDexInProcess

public void setDexInProcess(boolean dexInProcess)

getKeepRuntimeAnnotatedClasses

public boolean getKeepRuntimeAnnotatedClasses()

Keep all classes with runtime annotations in the main dex in legacy multidex.

This is enabled by default and works around an issue that will cause the app to crash when using java.lang.reflect.Field.getDeclaredAnnotations on older android versions.

This can be disabled for for apps that do not use reflection and need more space in their main dex.

See http://b.android.com/78144.

Specified by:

getKeepRuntimeAnnotatedClasses in interface DexOptions

setKeepRuntimeAnnotatedClasses

public void setKeepRuntimeAnnotatedClasses(boolean keepRuntimeAnnotatedClasses)

getThreadCount

@Nullable
public java.lang.Integer getThreadCount()

Number of threads to use when running dx. Defaults to 4.

Specified by:

getThreadCount in interface DexOptions

setThreadCount

public void setThreadCount(java.lang.Integer threadCount)

getJavaMaxHeapSize

@Nullable
public java.lang.String getJavaMaxHeapSize()

Specifies the -Xmx value when calling dx. Example value is "2048m".

Specified by:

getJavaMaxHeapSize in interface DexOptions

setJavaMaxHeapSize

public void setJavaMaxHeapSize(java.lang.String javaMaxHeapSize)

getAdditionalParameters

@NonNull
public java.util.List<java.lang.String> getAdditionalParameters()

List of additional parameters to be passed to dx.

Specified by:

getAdditionalParameters in interface DexOptions

setAdditionalParameters

public void setAdditionalParameters(@NonNull
                                    java.util.List<java.lang.String> additionalParameters)

getMaxProcessCount

@Nullable
public java.lang.Integer getMaxProcessCount()

Returns the maximum number of concurrent processes that can be used to dex. Defaults to 4.

Be aware that the number of concurrent process times the memory requirement represent the minimum amount of memory that will be used by the dx processes:

Total Memory = maxProcessCount * javaMaxHeapSize

To avoid thrashing, keep these two settings appropriate for your configuration.

Specified by:

getMaxProcessCount in interface DexOptions

Returns:

the max number of concurrent dx processes.

setMaxProcessCount

public void setMaxProcessCount(java.lang.Integer maxProcessCount)

getOptimize

@Deprecated
 @Nullable
public java.lang.Boolean getOptimize()

Deprecated. Dex is always optimized. This returns true always.

Whether to run the dx compiler with the --no-optimize flag.