com.facebook.buck.android

Class AndroidBinary

java.lang.Object

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

com.facebook.buck.android.AndroidBinary

All Implemented Interfaces:

HasInstallableApk, BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, HasInstallHelpers, HasRuntimeDeps, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, HasClasspathDeps, HasClasspathEntries, Comparable<BuildRule>

Direct Known Subclasses:

AndroidInstrumentationApk

public class AndroidBinary
extends AbstractBuildRule
implements SupportsInputBasedRuleKey, HasDeclaredAndExtraDeps, HasClasspathDeps, HasClasspathEntries, HasRuntimeDeps, HasInstallableApk, HasInstallHelpers

 android_binary(
   name = 'messenger',
   manifest = 'AndroidManifest.xml',
   deps = [
     '//src/com/facebook/messenger:messenger_library',
   ],
 )
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.android.HasInstallableApk

HasInstallableApk.ApkInfo

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	deprecatedGetExtraDeps()
AndroidPackageableCollection	getAndroidPackageableCollection()
HasInstallableApk.ApkInfo	getApkInfo() The APK at this path is the final one that points to an APK that a user should install.
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<? extends Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
com.google.common.collect.ImmutableSet<BuildTarget>	getBuildTargetsToExcludeFromDex()
com.google.common.collect.ImmutableSet<TargetCpuType>	getCpuFilters()
SortedSet<BuildRule>	getDeclaredDeps()
Set<BuildRule>	getDepsForTransitiveClasspathEntries()
com.google.common.collect.ImmutableSet<SourcePath>	getImmediateClasspaths() Returns the classpaths for only this rule, not its deps.
java.util.stream.Stream<BuildTarget>	getInstallHelpers()
Keystore	getKeystore()
ManifestEntries	getManifestEntries()
int	getOptimizationPasses()
com.google.common.collect.ImmutableSet<SourcePath>	getOutputClasspaths()
Optional<SourcePath>	getProguardConfig()
Optional<List<String>>	getProguardJvmArgs()
com.facebook.buck.android.ResourcesFilter.ResourceCompressionMode	getResourceCompressionMode()
FilterResourcesSteps.ResourceFilter	getResourceFilter()
java.util.function.Supplier<com.google.common.collect.ImmutableSet<JavaLibrary>>	getRulesToExcludeFromDex()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
boolean	getSkipProguard()
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSortedSet<BuildRule>	getTargetGraphOnlyDeps()
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()
boolean	inputBasedRuleKeyIsEnabled()
boolean	isCacheable() Whether this BuildRule can be cached.

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

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

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.SupportsInputBasedRuleKey

isSupported

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

compareTo, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, 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.android.HasInstallableApk

getBuildTarget, getProjectFilesystem

Method Detail

getBuildDeps

public SortedSet<BuildRule> getBuildDeps()

Specified by:

getBuildDeps in interface BuildRule

Returns:

the set of rules that must be built before this rule. Normally, this matches the value of the deps argument for this build rule in the build file in which it was defined.

However, there are special cases where other arguments pull in implicit dependencies (e.g., the keystore argument in android_binary). In these cases, the implicit dependencies are also included in the set returned by this method. The value of the original deps argument, as defined in the build file, must be accessed via a custom getter provided by the build rule.

getDeclaredDeps

public SortedSet<BuildRule> getDeclaredDeps()

Specified by:

getDeclaredDeps in interface HasDeclaredAndExtraDeps

deprecatedGetExtraDeps

public SortedSet<BuildRule> deprecatedGetExtraDeps()

Specified by:

deprecatedGetExtraDeps in interface HasDeclaredAndExtraDeps

getTargetGraphOnlyDeps

public com.google.common.collect.ImmutableSortedSet<BuildRule> getTargetGraphOnlyDeps()

Specified by:

getTargetGraphOnlyDeps in interface HasDeclaredAndExtraDeps

getRulesToExcludeFromDex

public java.util.function.Supplier<com.google.common.collect.ImmutableSet<JavaLibrary>> getRulesToExcludeFromDex()

getBuildTargetsToExcludeFromDex

public com.google.common.collect.ImmutableSet<BuildTarget> getBuildTargetsToExcludeFromDex()

getProguardConfig

public Optional<SourcePath> getProguardConfig()

getSkipProguard

public boolean getSkipProguard()

getResourceCompressionMode

public com.facebook.buck.android.ResourcesFilter.ResourceCompressionMode getResourceCompressionMode()

getCpuFilters

public com.google.common.collect.ImmutableSet<TargetCpuType> getCpuFilters()

getResourceFilter

public FilterResourcesSteps.ResourceFilter getResourceFilter()

getOptimizationPasses

public int getOptimizationPasses()

getProguardJvmArgs

public Optional<List<String>> getProguardJvmArgs()

getManifestEntries

public ManifestEntries getManifestEntries()

getApkInfo

public HasInstallableApk.ApkInfo getApkInfo()

The APK at this path is the final one that points to an APK that a user should install.

Specified by:

getApkInfo in interface HasInstallableApk

getInstallHelpers

public java.util.stream.Stream<BuildTarget> getInstallHelpers()

Specified by:

getInstallHelpers in interface HasInstallHelpers

isCacheable

public boolean isCacheable()

Description copied from interface: BuildRule

Whether this BuildRule can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

Uncached rules are not always rebuilt, however, as long as the existing on-disk representation is up to date. This means that these rules can take advantage of SupportsInputBasedRuleKey to prevent rebuilding.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule

inputBasedRuleKeyIsEnabled

public boolean inputBasedRuleKeyIsEnabled()

Specified by:

inputBasedRuleKeyIsEnabled in interface SupportsInputBasedRuleKey

getBuildSteps

public com.google.common.collect.ImmutableList<? extends Step> getBuildSteps(BuildContext context,
                                                                             BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getAndroidPackageableCollection

public AndroidPackageableCollection getAndroidPackageableCollection()

getKeystore

public Keystore getKeystore()

getTransitiveClasspaths

public com.google.common.collect.ImmutableSet<SourcePath> getTransitiveClasspaths()

Specified by:

getTransitiveClasspaths in interface HasClasspathEntries

Returns:

Classpath entries for this rule and its dependencies. e.g. If the rule represents a java library, then these entries will be passed to javac's -classpath flag in order to build a jar associated with this rule.

getTransitiveClasspathDeps

public com.google.common.collect.ImmutableSet<JavaLibrary> getTransitiveClasspathDeps()

Specified by:

getTransitiveClasspathDeps in interface HasClasspathEntries

Returns:

A set of rules contributing classpath entries for this rule and its dependencies.

getImmediateClasspaths

public com.google.common.collect.ImmutableSet<SourcePath> getImmediateClasspaths()

Description copied from interface: HasClasspathEntries

Returns the classpaths for only this rule, not its deps.

Used to generate the value of HasClasspathEntries.getTransitiveClasspaths().

Specified by:

getImmediateClasspaths in interface HasClasspathEntries

getOutputClasspaths

public com.google.common.collect.ImmutableSet<SourcePath> getOutputClasspaths()

Specified by:

getOutputClasspaths in interface HasClasspathEntries

Returns:

Classpath entries that this rule will contribute when it is used as a dependency. e.g. If the rule represents a java library, then these entries must be passed to javac's -classpath flag in order to compile rules that depend on this rule. This is a superset of getImmediateClasspaths which also contains the classpath entries of any exported deps.

getRuntimeDeps

public java.util.stream.Stream<BuildTarget> getRuntimeDeps(BuildRuleResolver buildRuleResolver)

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

getDepsForTransitiveClasspathEntries

public Set<BuildRule> getDepsForTransitiveClasspathEntries()

Specified by:

getDepsForTransitiveClasspathEntries in interface HasClasspathDeps

Returns:

all direct dependencies which may contribute to the classpath of this rule