com.facebook.buck.android

Class DxStep

java.lang.Object

com.facebook.buck.shell.ShellStep

com.facebook.buck.android.DxStep

All Implemented Interfaces:

Step

public class DxStep
extends ShellStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DxStep.Option Options to pass to dx.

Field Summary

Fields

Modifier and Type	Field and Description
static String	D8
static int	DEX_REFERENCE_OVERFLOW_EXIT_CODE
static String	DX Available tools to create dex files *
static int	FAILURE_EXIT_CODE
static int	SUCCESS_EXIT_CODE

Fields inherited from class com.facebook.buck.shell.ShellStep

workingDirectory

Constructor Summary

Constructors

Constructor and Description
DxStep(ProjectFilesystem filesystem, AndroidPlatformTarget androidPlatformTarget, Path outputDexFile, Iterable<Path> filesToDex)
DxStep(ProjectFilesystem filesystem, AndroidPlatformTarget androidPlatformTarget, Path outputDexFile, Iterable<Path> filesToDex, EnumSet<DxStep.Option> options, Optional<String> maxHeapSize, String dexTool, boolean intermediate)
DxStep(ProjectFilesystem filesystem, AndroidPlatformTarget androidPlatformTarget, Path outputDexFile, Iterable<Path> filesToDex, EnumSet<DxStep.Option> options, Optional<String> maxHeapSize, String dexTool, boolean intermediate, Collection<Path> classpathFiles, Optional<String> bucketId, Optional<Integer> minSdkVersion)
DxStep(ProjectFilesystem filesystem, AndroidPlatformTarget androidPlatformTarget, Path outputDexFile, Iterable<Path> filesToDex, EnumSet<DxStep.Option> options, String dexTool)

Method Summary

Modifier and Type	Method and Description
StepExecutionResult	execute(ExecutionContext context)
Path	getOutputDexFile()
protected com.google.common.collect.ImmutableList<String>	getShellCommandInternal(ExecutionContext context) Implementations of this method should not have any observable side-effects.
String	getShortName()
protected boolean	shouldPrintStderr(Verbosity verbosity)
protected boolean	shouldPrintStdout(Verbosity verbosity)

Methods inherited from class com.facebook.buck.shell.ShellStep

addOptions, getDescription, getDuration, getEnvironmentVariables, getExitCodeFromResult, getShellCommand, getShellCommandArgsForDescription, getStderr, getStdin, getStdout, getTimeout, getTimeoutHandler

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS_EXIT_CODE

public static final int SUCCESS_EXIT_CODE

See Also:

Constant Field Values

FAILURE_EXIT_CODE

public static final int FAILURE_EXIT_CODE

See Also:

Constant Field Values

DEX_REFERENCE_OVERFLOW_EXIT_CODE

public static final int DEX_REFERENCE_OVERFLOW_EXIT_CODE

See Also:

Constant Field Values

DX

public static final String DX

Available tools to create dex files *

See Also:

Constant Field Values

D8

public static final String D8

See Also:

Constant Field Values

Constructor Detail

DxStep

public DxStep(ProjectFilesystem filesystem,
              AndroidPlatformTarget androidPlatformTarget,
              Path outputDexFile,
              Iterable<Path> filesToDex)

Parameters:

outputDexFile - path to the file where the generated classes.dex should go.

filesToDex - each element in this set is a path to a .class file, a zip file of .class files, or a directory of .class files.

DxStep

public DxStep(ProjectFilesystem filesystem,
              AndroidPlatformTarget androidPlatformTarget,
              Path outputDexFile,
              Iterable<Path> filesToDex,
              EnumSet<DxStep.Option> options,
              String dexTool)

Parameters:

outputDexFile - path to the file where the generated classes.dex should go.

filesToDex - each element in this set is a path to a .class file, a zip file of .class files, or a directory of .class files.

options - to pass to dx.

dexTool - the tool used to perform dexing.

DxStep

public DxStep(ProjectFilesystem filesystem,
              AndroidPlatformTarget androidPlatformTarget,
              Path outputDexFile,
              Iterable<Path> filesToDex,
              EnumSet<DxStep.Option> options,
              Optional<String> maxHeapSize,
              String dexTool,
              boolean intermediate)

Parameters:

outputDexFile - path to the file where the generated classes.dex should go.

filesToDex - each element in this set is a path to a .class file, a zip file of .class files, or a directory of .class files.

options - to pass to dx.

maxHeapSize - The max heap size used for out of process dex.

dexTool - the tool used to perform dexing.

DxStep

public DxStep(ProjectFilesystem filesystem,
              AndroidPlatformTarget androidPlatformTarget,
              Path outputDexFile,
              Iterable<Path> filesToDex,
              EnumSet<DxStep.Option> options,
              Optional<String> maxHeapSize,
              String dexTool,
              boolean intermediate,
              @Nullable
              Collection<Path> classpathFiles,
              Optional<String> bucketId,
              Optional<Integer> minSdkVersion)

Parameters:

outputDexFile - path to the file where the generated classes.dex should go.

filesToDex - each element in this set is a path to a .class file, a zip file of .class files, or a directory of .class files.

options - to pass to dx.

maxHeapSize - The max heap size used for out of process dex.

dexTool - the tool used to perform dexing.

classpathFiles - specifies classpath for interface static and default methods desugaring.

minSdkVersion -

Method Detail

getShellCommandInternal

protected com.google.common.collect.ImmutableList<String> getShellCommandInternal(ExecutionContext context)

Description copied from class: ShellStep

Implementations of this method should not have any observable side-effects.

Specified by:

getShellCommandInternal in class ShellStep

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException,
                                   InterruptedException

Specified by:

execute in interface Step

Overrides:

execute in class ShellStep

Throws:

IOException

InterruptedException

shouldPrintStderr

protected boolean shouldPrintStderr(Verbosity verbosity)

Overrides:

shouldPrintStderr in class ShellStep

Returns:

whether the stderr of the shell command, when executed, should be printed to the stderr of the specified ExecutionContext. If false, stderr will only be printed on error and only if verbosity is set to standard information.

shouldPrintStdout

protected boolean shouldPrintStdout(Verbosity verbosity)

Overrides:

shouldPrintStdout in class ShellStep

Parameters:

verbosity - is provided in case that affects what should be printed.

Returns:

whether the stdout of the shell command, when executed, should be printed to the stderr of the specified ExecutionContext. If false, stdout will only be printed on error and only if verbosity is set to standard information.

getShortName

public String getShortName()

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getOutputDexFile

public Path getOutputDexFile()