com.facebook.buck.android

Class SplitZipStep

java.lang.Object

com.facebook.buck.android.SplitZipStep

All Implemented Interfaces:

Step

public class SplitZipStep
extends Object
implements Step

Split zipping tool designed to divide input code blobs into a set of output jar files such that none will exceed the DexOpt LinearAlloc limit or the dx method limit when passed through dx --dex.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SECONDARY_DEX_ID

Constructor Summary

Constructors

Constructor and Description

SplitZipStep(ProjectFilesystem filesystem, Set<Path> inputPathsToSplit, Path secondaryJarMetaPath, Path primaryJarPath, Path secondaryJarDir, String secondaryJarPattern, Path addtionalDexStoreJarMetaPath, Path additionalDexStoreJarDir, Optional<Path> proguardFullConfigFile, Optional<Path> proguardMappingFile, boolean skipProguard, com.facebook.buck.android.DexSplitMode dexSplitMode, Optional<Path> primaryDexScenarioFile, Optional<Path> primaryDexClassesFile, Optional<Path> secondaryDexHeadClassesFile, Optional<Path> secondaryDexTailClassesFile, com.google.common.collect.ImmutableMultimap<APKModule,Path> apkModuleToJarPathMap, com.google.common.collect.ImmutableSortedMap<APKModule,com.google.common.collect.ImmutableSortedSet<APKModule>> apkModuleMap, APKModule rootAPKModule, Path pathToReportDir)

Method Summary

Modifier and Type	Method and Description
StepExecutionResult	execute(ExecutionContext context)
String	getDescription(ExecutionContext context)
java.util.function.Supplier<com.google.common.collect.Multimap<Path,Path>>	getOutputToInputsMapSupplier(Path secondaryOutputDir, Path additionalOutputDir)
String	getShortName()

Methods inherited from class java.lang.Object

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

Field Detail

SECONDARY_DEX_ID

public static final String SECONDARY_DEX_ID

See Also:

Constant Field Values

Constructor Detail

SplitZipStep

public SplitZipStep(ProjectFilesystem filesystem,
                    Set<Path> inputPathsToSplit,
                    Path secondaryJarMetaPath,
                    Path primaryJarPath,
                    Path secondaryJarDir,
                    String secondaryJarPattern,
                    Path addtionalDexStoreJarMetaPath,
                    Path additionalDexStoreJarDir,
                    Optional<Path> proguardFullConfigFile,
                    Optional<Path> proguardMappingFile,
                    boolean skipProguard,
                    com.facebook.buck.android.DexSplitMode dexSplitMode,
                    Optional<Path> primaryDexScenarioFile,
                    Optional<Path> primaryDexClassesFile,
                    Optional<Path> secondaryDexHeadClassesFile,
                    Optional<Path> secondaryDexTailClassesFile,
                    com.google.common.collect.ImmutableMultimap<APKModule,Path> apkModuleToJarPathMap,
                    com.google.common.collect.ImmutableSortedMap<APKModule,com.google.common.collect.ImmutableSortedSet<APKModule>> apkModuleMap,
                    APKModule rootAPKModule,
                    Path pathToReportDir)

Parameters:

inputPathsToSplit - Input paths that would otherwise have been passed to a single dx --dex invocation.

secondaryJarMetaPath - Output location for the metadata text file describing each secondary jar artifact.

primaryJarPath - Output path for the primary jar file.

secondaryJarDir - Output location for secondary jar files. Note that this directory may be empty if no secondary jar files are needed.

secondaryJarPattern - Filename pattern for secondary jar files. Pattern contains one %d argument representing the enumerated secondary zip count (starting at 1).

proguardFullConfigFile - Path to the full generated ProGuard configuration, generated by the -printconfiguration flag. This is part of the *output* of ProGuard.

proguardMappingFile - Path to the mapping file generated by ProGuard's obfuscation.

apkModuleMap -

rootAPKModule -

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:

execute in interface Step

Throws:

IOException

getShortName

public String getShortName()

Specified by:

getShortName in interface Step

Returns:

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

getDescription

public String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step

getOutputToInputsMapSupplier

public java.util.function.Supplier<com.google.common.collect.Multimap<Path,Path>> getOutputToInputsMapSupplier(Path secondaryOutputDir,
                                                                                                               Path additionalOutputDir)