com.facebook.buck.android

Class AndroidResource

java.lang.Object

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

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

com.facebook.buck.android.AndroidResource

All Implemented Interfaces:

HasAndroidResourceDeps, AndroidPackageable, BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, InitializableFromDisk<String>, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, HasClasspathDeps, Comparable<BuildRule>

public class AndroidResource
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements AndroidPackageable, HasAndroidResourceDeps, HasClasspathDeps, InitializableFromDisk<String>, SupportsInputBasedRuleKey

An object that represents the resources of an android library.

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

 android_resources(
   name = 'res',
   res = 'res',
   assets = 'buck-assets',
   deps = [
     '//first-party/orca/lib-ui:lib-ui',
   ],
 )
 

Constructor Summary

Constructors

Constructor and Description
AndroidResource(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams buildRuleParams, SourcePathRuleFinder ruleFinder, com.google.common.collect.ImmutableSortedSet<BuildRule> deps, SourcePath res, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> resSrcs, String rDotJavaPackageArgument, SourcePath assets, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> assetsSrcs, SourcePath manifestFile, boolean hasWhitelistedStrings)
AndroidResource(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams buildRuleParams, SourcePathRuleFinder ruleFinder, com.google.common.collect.ImmutableSortedSet<BuildRule> deps, SourcePath res, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> resSrcs, String rDotJavaPackageArgument, SourcePath assets, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> assetsSrcs, SourcePath manifestFile, boolean hasWhitelistedStrings, boolean resourceUnion, boolean isGrayscaleImageProcessingEnabled)
AndroidResource(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams buildRuleParams, SourcePathRuleFinder ruleFinder, com.google.common.collect.ImmutableSortedSet<BuildRule> deps, SourcePath res, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> resSrcs, String rDotJavaPackageArgument, SourcePath assets, com.google.common.collect.ImmutableSortedMap<Path,SourcePath> assetsSrcs, SourcePath manifestFile, java.util.function.Supplier<com.google.common.collect.ImmutableSortedSet<? extends SourcePath>> symbolFilesFromDeps, boolean hasWhitelistedStrings, boolean resourceUnion, boolean isGrayscaleImageProcessingEnabled)

Method Summary

Modifier and Type	Method and Description
void	addToCollector(AndroidPackageableCollector collector) Add concrete resources to the given collector.
SourcePath	getAssets()
BuildOutputInitializer<String>	getBuildOutputInitializer()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Set<BuildRule>	getDepsForTransitiveClasspathEntries()
SourcePath	getManifestFile()
SourcePath	getPathToRDotJavaPackageFile()
SourcePath	getPathToTextSymbolsFile()
String	getRDotJavaPackage()
Iterable<AndroidPackageable>	getRequiredPackageables(BuildRuleResolver ruleResolver) Get the set of packagables that need to be included in any package that includes this object.
SourcePath	getRes()
SourcePath	getSourcePathToOutput()
String	initializeFromDisk(SourcePathResolverAdapter pathResolver)

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.android.HasAndroidResourceDeps

getBuildTarget

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

invalidateInitializeFromDiskState

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

inputBasedRuleKeyIsEnabled, isSupported

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

compareTo, getBuildDeps, 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

Constructor Detail

AndroidResource

public AndroidResource(BuildTarget buildTarget,
                       ProjectFilesystem projectFilesystem,
                       BuildRuleParams buildRuleParams,
                       SourcePathRuleFinder ruleFinder,
                       com.google.common.collect.ImmutableSortedSet<BuildRule> deps,
                       @Nullable
                       SourcePath res,
                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> resSrcs,
                       @Nullable
                       String rDotJavaPackageArgument,
                       @Nullable
                       SourcePath assets,
                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> assetsSrcs,
                       @Nullable
                       SourcePath manifestFile,
                       java.util.function.Supplier<com.google.common.collect.ImmutableSortedSet<? extends SourcePath>> symbolFilesFromDeps,
                       boolean hasWhitelistedStrings,
                       boolean resourceUnion,
                       boolean isGrayscaleImageProcessingEnabled)

AndroidResource

public AndroidResource(BuildTarget buildTarget,
                       ProjectFilesystem projectFilesystem,
                       BuildRuleParams buildRuleParams,
                       SourcePathRuleFinder ruleFinder,
                       com.google.common.collect.ImmutableSortedSet<BuildRule> deps,
                       @Nullable
                       SourcePath res,
                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> resSrcs,
                       @Nullable
                       String rDotJavaPackageArgument,
                       @Nullable
                       SourcePath assets,
                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> assetsSrcs,
                       @Nullable
                       SourcePath manifestFile,
                       boolean hasWhitelistedStrings)

AndroidResource

public AndroidResource(BuildTarget buildTarget,
                       ProjectFilesystem projectFilesystem,
                       BuildRuleParams buildRuleParams,
                       SourcePathRuleFinder ruleFinder,
                       com.google.common.collect.ImmutableSortedSet<BuildRule> deps,
                       @Nullable
                       SourcePath res,
                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> resSrcs,
                       @Nullable
                       String rDotJavaPackageArgument,
                       @Nullable
                       SourcePath assets,
                       com.google.common.collect.ImmutableSortedMap<Path,SourcePath> assetsSrcs,
                       @Nullable
                       SourcePath manifestFile,
                       boolean hasWhitelistedStrings,
                       boolean resourceUnion,
                       boolean isGrayscaleImageProcessingEnabled)

Method Detail

getRes

@Nullable
public SourcePath getRes()

Specified by:

getRes in interface HasAndroidResourceDeps

Returns:

path to a directory containing Android resources.

getAssets

@Nullable
public SourcePath getAssets()

Specified by:

getAssets in interface HasAndroidResourceDeps

Returns:

path to a directory containing Android assets.

getManifestFile

@Nullable
public SourcePath getManifestFile()

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getPathToTextSymbolsFile

public SourcePath getPathToTextSymbolsFile()

Specified by:

getPathToTextSymbolsFile in interface HasAndroidResourceDeps

Returns:

path to a temporary directory for storing text symbols.

getPathToRDotJavaPackageFile

public SourcePath getPathToRDotJavaPackageFile()

Specified by:

getPathToRDotJavaPackageFile in interface HasAndroidResourceDeps

Returns:

path to a file containing the package name for R.java.

getRDotJavaPackage

public String getRDotJavaPackage()

Specified by:

getRDotJavaPackage in interface HasAndroidResourceDeps

Returns:

the package name in which to generate the R.java representing these resources.

initializeFromDisk

public String initializeFromDisk(SourcePathResolverAdapter pathResolver)

Specified by:

initializeFromDisk in interface InitializableFromDisk<String>

Returns:

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

getBuildOutputInitializer

public BuildOutputInitializer<String> getBuildOutputInitializer()

Specified by:

getBuildOutputInitializer in interface InitializableFromDisk<String>

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.

getDepsForTransitiveClasspathEntries

public Set<BuildRule> getDepsForTransitiveClasspathEntries()

Specified by:

getDepsForTransitiveClasspathEntries in interface HasClasspathDeps

Returns:

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