com.facebook.buck.android

Class PrebuiltNativeLibrary

java.lang.Object

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

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.android.PrebuiltNativeLibrary

All Implemented Interfaces:

NativeLibraryBuildRule, AndroidPackageable, BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, Comparable<BuildRule>

public class PrebuiltNativeLibrary
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements NativeLibraryBuildRule, AndroidPackageable

An object that represents the resources prebuilt native library.

Suppose this were a rule defined in src/com/facebook/feed/BUILD:

 prebuilt_native_library(
   name = 'face_dot_com',
   native_libs = 'nativeLibs',
 )
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrebuiltNativeLibrary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, Path nativeLibsDirectory, boolean isAsset, com.google.common.collect.ImmutableSortedSet<? extends SourcePath> librarySources)

Method Summary

Modifier and Type	Method and Description
void	addToCollector(AndroidPackageableCollector collector) Add concrete resources to the given collector.
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Path	getLibraryPath() Returns the path to the directory containing .so files organized by target CPU architecture.
Iterable<AndroidPackageable>	getRequiredPackageables(BuildRuleResolver ruleResolver) Get the set of packagables that need to be included in any package that includes this object.
SourcePath	getSourcePathToOutput()
boolean	isAsset()

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

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, 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.BuildRule

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

PrebuiltNativeLibrary

protected PrebuiltNativeLibrary(BuildTarget buildTarget,
                                ProjectFilesystem projectFilesystem,
                                BuildRuleParams params,
                                Path nativeLibsDirectory,
                                boolean isAsset,
                                com.google.common.collect.ImmutableSortedSet<? extends SourcePath> librarySources)

Method Detail

isAsset

public boolean isAsset()

Specified by:

isAsset in interface NativeLibraryBuildRule

Returns:

A boolean indicating whether the .so files in the directory returned by NativeLibraryBuildRule.getLibraryPath() should be included in the assets folder in the APK.

getLibraryPath

public Path getLibraryPath()

Description copied from interface: NativeLibraryBuildRule

Returns the path to the directory containing .so files organized by target CPU architecture. This often contains subdirectories such as:

• armeabi
• armeabi-v7a

Specified by:

getLibraryPath in interface NativeLibraryBuildRule

Returns:

A path relative to the project root that should does not include a trailing slash.

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getRequiredPackageables

public Iterable<AndroidPackageable> getRequiredPackageables(BuildRuleResolver ruleResolver)

Description copied from interface: AndroidPackageable

Get the set of packagables that need to be included in any package that includes this object.

For example, an android_library will need all of its Java deps (except provided_deps), its resource deps, and its native library deps (even though it doesn't need the native library as a build-time dependency). An android_resource might need an android_library that declares a custom view that it references, as well as other android_resource rules that it references directly.

TODO(natthu): Once build rules and buildables are merged, replace this method with another interface that lets an AndroidPackageable override the default set which is all deps of the type AndroidPackageable.

Specified by:

getRequiredPackageables in interface AndroidPackageable

Returns:

All AndroidPackageables that must be included along with this one.

addToCollector

public void addToCollector(AndroidPackageableCollector collector)

Description copied from interface: AndroidPackageable

Add concrete resources to the given collector.

Implementations should call methods on the collector specify what concrete content must be included in an Android package that includes this object. For example, an android_library will add Java classes, an ndk_library will add native libraries, and android_resource will add resource directories.

Specified by:

addToCollector in interface AndroidPackageable

Parameters:

collector - The AndroidPackageableCollector that will receive the content.