com.facebook.buck.android

Class ResourcesFilter

java.lang.Object

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

com.facebook.buck.android.ResourcesFilter

All Implemented Interfaces:

FilteredResourcesProvider, BuildEngineAction, AllowsNonAnnotatedFields, InitializableFromDisk<ResourcesFilter.BuildOutput>, BuildRule, HasNameAndType, Comparable<BuildRule>

public class ResourcesFilter
extends AbstractBuildRule
implements FilteredResourcesProvider, InitializableFromDisk<ResourcesFilter.BuildOutput>

Buildable that is responsible for taking a set of res/ directories and applying an optional resource filter to them, ultimately generating the final set of res/ directories whose contents should be included in an APK.

Clients of this Buildable may need to know:

• The set of res/ directories that was used to calculate the R.java file. (These are needed as arguments to aapt to create the unsigned APK, as well as arguments to create a ProGuard config, if appropriate.)
• The set of non-english strings.xml files identified by the resource filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourcesFilter.BuildOutput

Constructor Summary

Constructors

Constructor and Description

ResourcesFilter(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, com.google.common.collect.ImmutableSortedSet<BuildRule> resourceRules, com.google.common.collect.ImmutableCollection<BuildRule> rulesWithResourceDirectories, SourcePathRuleFinder ruleFinder, com.google.common.collect.ImmutableList<SourcePath> resDirectories, com.google.common.collect.ImmutableSet<SourcePath> whitelistedStringDirs, com.google.common.collect.ImmutableSet<String> locales, Optional<String> localizedStringFileName, com.facebook.buck.android.ResourcesFilter.ResourceCompressionMode resourceCompressionMode, FilterResourcesSteps.ResourceFilter resourceFilter, Optional<Arg> postFilterResourcesCmd)

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	getBuildDeps()
BuildOutputInitializer<ResourcesFilter.BuildOutput>	getBuildOutputInitializer()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Optional<SourcePath>	getOverrideSymbolsPath()
com.google.common.collect.ImmutableList<SourcePath>	getResDirectories()
Optional<BuildRule>	getResourceFilterRule()
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableList<Path>	getStringFiles()
boolean	hasResources()
ResourcesFilter.BuildOutput	initializeFromDisk(SourcePathResolverAdapter pathResolver)

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

getRelativeResDirectories

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

invalidateInitializeFromDiskState

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

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

ResourcesFilter

public ResourcesFilter(BuildTarget buildTarget,
                       ProjectFilesystem projectFilesystem,
                       com.google.common.collect.ImmutableSortedSet<BuildRule> resourceRules,
                       com.google.common.collect.ImmutableCollection<BuildRule> rulesWithResourceDirectories,
                       SourcePathRuleFinder ruleFinder,
                       com.google.common.collect.ImmutableList<SourcePath> resDirectories,
                       com.google.common.collect.ImmutableSet<SourcePath> whitelistedStringDirs,
                       com.google.common.collect.ImmutableSet<String> locales,
                       Optional<String> localizedStringFileName,
                       com.facebook.buck.android.ResourcesFilter.ResourceCompressionMode resourceCompressionMode,
                       FilterResourcesSteps.ResourceFilter resourceFilter,
                       Optional<Arg> postFilterResourcesCmd)

Method Detail

getResDirectories

public com.google.common.collect.ImmutableList<SourcePath> getResDirectories()

Specified by:

getResDirectories in interface FilteredResourcesProvider

Returns:

The set of res/ directories that should be used to calculate the final R.java file.

getStringFiles

public com.google.common.collect.ImmutableList<Path> getStringFiles()

Specified by:

getStringFiles in interface FilteredResourcesProvider

Returns:

The list of strings.xml files excluding whitelisted strings. Empty unless ResourceCompressionMode.isStoreStringsAsAssets is true.

getResourceFilterRule

public Optional<BuildRule> getResourceFilterRule()

Specified by:

getResourceFilterRule in interface FilteredResourcesProvider

hasResources

public boolean hasResources()

Specified by:

hasResources in interface FilteredResourcesProvider

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.

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getOverrideSymbolsPath

public Optional<SourcePath> getOverrideSymbolsPath()

Specified by:

getOverrideSymbolsPath in interface FilteredResourcesProvider

initializeFromDisk

public ResourcesFilter.BuildOutput initializeFromDisk(SourcePathResolverAdapter pathResolver)
                                               throws IOException

Specified by:

initializeFromDisk in interface InitializableFromDisk<ResourcesFilter.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<ResourcesFilter.BuildOutput> getBuildOutputInitializer()

Specified by:

getBuildOutputInitializer in interface InitializableFromDisk<ResourcesFilter.BuildOutput>

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule