com.facebook.buck.android

Class ApkGenrule

java.lang.Object

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

com.facebook.buck.rules.modern.ModernBuildRule<T>

com.facebook.buck.shell.BaseGenrule<com.facebook.buck.android.ApkGenrule.Buildable>

com.facebook.buck.android.ApkGenrule

All Implemented Interfaces:

HasInstallableApk, BuildEngineAction, HasOutputName, AllowsNonAnnotatedFields, HasMultipleOutputs, HasRuntimeDeps, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, HasClasspathEntries, Comparable<BuildRule>

public final class ApkGenrule
extends BaseGenrule<com.facebook.buck.android.ApkGenrule.Buildable>
implements HasInstallableApk, HasRuntimeDeps, HasClasspathEntries

A specialization of a genrule that specifically allows the modification of apks. This is useful for processes that modify an APK, such as zipaligning it or signing it.

The generated APK will be at rule_name.apk.

 apk_genrule(
   name = 'fb4a_signed',
   apk = ':fbandroid_release'
   deps = [
     '//java/com/facebook/sign:fbsign_jar',
   ],
   cmd = '${//java/com/facebook/sign:fbsign_jar} --input $APK --output $OUT'
 )
 

Nested Class Summary

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

HasInstallableApk.ApkInfo

Method Summary

Modifier and Type	Method and Description
HasInstallableApk.ApkInfo	getApkInfo()
com.google.common.collect.ImmutableSet<SourcePath>	getImmediateClasspaths() Returns the classpaths for only this rule, not its deps.
HasInstallableApk	getInstallableApk()
com.google.common.collect.ImmutableSet<SourcePath>	getOutputClasspaths()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()

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

getOutputLabels, getOutputName, getSourcePathToOutput, getSourcePathToOutput, getType, isCacheable

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, hasBuildSteps, hashCode, injectFields, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.android.HasInstallableApk

getBuildTarget, getProjectFilesystem

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

compareTo, getBuildDeps, getBuildSteps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, getSourcePathToOutput, 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

Method Detail

getInstallableApk

public HasInstallableApk getInstallableApk()

getApkInfo

public HasInstallableApk.ApkInfo getApkInfo()

Specified by:

getApkInfo in interface HasInstallableApk

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

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.