com.facebook.buck.android

Class DexProducedFromJavaLibrary

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.rules.modern.ModernBuildRule<com.facebook.buck.android.DexProducedFromJavaLibrary.Impl>

com.facebook.buck.android.DexProducedFromJavaLibrary

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, InitializableFromDisk<com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput>, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, Comparable<BuildRule>

public class DexProducedFromJavaLibrary
extends ModernBuildRule<com.facebook.buck.android.DexProducedFromJavaLibrary.Impl>
implements InitializableFromDisk<com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput>

DexProducedFromJavaLibrary is a BuildRule that serves a very specific purpose: it takes a JavaLibrary and dexes the output of the JavaLibrary if its list of classes is non-empty. Because it is expected to be used with pre-dexing, we always pass the --force-jumbo flag to dx in this buildable.

Most BuildRules can determine the (possibly null) path to their output file from their definition. This is an anomaly because we do not know whether this will write a .dex file until runtime. Unfortunately, because there is no such thing as an empty .dex file, we cannot write a meaningful "dummy .dex" if there are no class files to pass to dx.

Constructor Summary

Constructors

Constructor and Description
DexProducedFromJavaLibrary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, AndroidPlatformTarget androidPlatformTarget, JavaLibrary javaLibrary)
DexProducedFromJavaLibrary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, AndroidPlatformTarget androidPlatformTarget, JavaLibrary javaLibrary, String dexTool, int weightFactor, com.google.common.collect.ImmutableSortedSet<BuildRule> desugarDeps)

Method Summary

Modifier and Type	Method and Description
BuildOutputInitializer<com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput>	getBuildOutputInitializer()
com.google.common.collect.ImmutableSortedSet<SourcePath>	getDesugarDeps()
BuildTarget	getJavaLibraryBuildTarget()
OutputPath	getPathToDex()
com.google.common.collect.ImmutableList<String>	getReferencedResources()
SourcePath	getSourcePathToOutput()
boolean	hasOutput()
com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput	initializeFromDisk(SourcePathResolverAdapter pathResolver)

Methods inherited from class com.facebook.buck.rules.modern.ModernBuildRule

compareTo, getBuildable, getBuildCellPathFactory, getBuildDeps, getBuildSteps, getOutputPathResolver, getSetupStepsForBuildable, getSourcePath, getSourcePaths, injectFieldsIfNecessary, inputBasedRuleKeyIsEnabled, recordOutputs, recordOutputs, recordOutputs, stepsForBuildable, stepsForBuildable, updateBuildRuleResolver

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.core.rules.attr.InitializableFromDisk

invalidateInitializeFromDiskState

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getBuildDeps, getBuildSteps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString, updateBuildRuleResolver

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Methods inherited from interface com.facebook.buck.core.rules.HasNameAndType

getType

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

isSupported

Constructor Detail

DexProducedFromJavaLibrary

public DexProducedFromJavaLibrary(BuildTarget buildTarget,
                                  ProjectFilesystem projectFilesystem,
                                  SourcePathRuleFinder ruleFinder,
                                  AndroidPlatformTarget androidPlatformTarget,
                                  JavaLibrary javaLibrary,
                                  String dexTool,
                                  int weightFactor,
                                  com.google.common.collect.ImmutableSortedSet<BuildRule> desugarDeps)

DexProducedFromJavaLibrary

public DexProducedFromJavaLibrary(BuildTarget buildTarget,
                                  ProjectFilesystem projectFilesystem,
                                  SourcePathRuleFinder ruleFinder,
                                  AndroidPlatformTarget androidPlatformTarget,
                                  JavaLibrary javaLibrary)

Method Detail

initializeFromDisk

public com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput initializeFromDisk(SourcePathResolverAdapter pathResolver)
                                                                                    throws IOException

Specified by:

initializeFromDisk in interface InitializableFromDisk<com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput>

Returns:

an object that has the in-memory data structures that need to be populated as a result of executing this object's steps.

Throws:

IOException

getBuildOutputInitializer

public BuildOutputInitializer<com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput> getBuildOutputInitializer()

Specified by:

getBuildOutputInitializer in interface InitializableFromDisk<com.facebook.buck.android.DexProducedFromJavaLibrary.BuildOutput>

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<com.facebook.buck.android.DexProducedFromJavaLibrary.Impl>

getDesugarDeps

public com.google.common.collect.ImmutableSortedSet<SourcePath> getDesugarDeps()

getPathToDex

public OutputPath getPathToDex()

hasOutput

public boolean hasOutput()

getReferencedResources

public com.google.common.collect.ImmutableList<String> getReferencedResources()

getJavaLibraryBuildTarget

public BuildTarget getJavaLibraryBuildTarget()