com.facebook.buck.jvm.java

Class DefaultJavaLibrary

java.lang.Object

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

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

com.facebook.buck.rules.modern.PipelinedModernBuildRule<JavacPipelineState,com.facebook.buck.jvm.java.DefaultJavaLibraryBuildable>

com.facebook.buck.jvm.java.DefaultJavaLibrary

All Implemented Interfaces:

AndroidPackageable, BuildEngineAction, AllowsNonAnnotatedFields, ExportDependencies, HasRuntimeDeps, InitializableFromDisk<JavaLibrary.Data>, SupportsDependencyFileRuleKey, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, SupportsPipelining<JavacPipelineState>, HasClasspathDeps, HasClasspathEntries, HasDesugarSupport, HasJavaAbi, HasJavaClassHashes, HasMavenCoordinates, HasSources, JavaLibrary, JavaLibraryWithTests, MaybeRequiredForSourceOnlyAbi, Comparable<BuildRule>

Direct Known Subclasses:

AndroidLibrary

public class DefaultJavaLibrary
extends PipelinedModernBuildRule<JavacPipelineState,com.facebook.buck.jvm.java.DefaultJavaLibraryBuildable>
implements JavaLibrary, ExportDependencies, InitializableFromDisk<JavaLibrary.Data>, AndroidPackageable, MaybeRequiredForSourceOnlyAbi, SupportsDependencyFileRuleKey, JavaLibraryWithTests

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

 java_library(
   name = 'feed',
   srcs = [
     'FeedStoryRenderer.java',
   ],
   deps = [
     '//src/com/facebook/feed/model:model',
     '//third-party/java/guava:guava',
   ],
 )
 

Then this would compile FeedStoryRenderer.java against Guava and the classes generated from the //src/com/facebook/feed/model:model rule.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.jvm.core.JavaLibrary

JavaLibrary.Data

Field Summary

Fields inherited from interface com.facebook.buck.jvm.core.JavaLibrary

GWT_MODULE_FLAVOR, MAVEN_JAR, SRC_JAR

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

DefaultJavaLibrary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, JarBuildStepsFactory jarBuildStepsFactory, SourcePathRuleFinder ruleFinder, Optional<SourcePath> proguardConfig, SortedSet<BuildRule> firstOrderPackageableDeps, com.google.common.collect.ImmutableSortedSet<BuildRule> fullJarExportedDeps, com.google.common.collect.ImmutableSortedSet<BuildRule> fullJarProvidedDeps, com.google.common.collect.ImmutableSortedSet<BuildRule> fullJarExportedProvidedDeps, com.google.common.collect.ImmutableSortedSet<BuildRule> runtimeDeps, BuildTarget abiJar, BuildTarget sourceOnlyAbiJar, Optional<String> mavenCoords, com.google.common.collect.ImmutableSortedSet<BuildTarget> tests, boolean requiredForSourceOnlyAbi, JavaBuckConfig.UnusedDependenciesAction unusedDependenciesAction, Optional<UnusedDependenciesFinderFactory> unusedDependenciesFinderFactory, CalculateSourceAbi sourceAbi, boolean isDesugarEnabled, boolean isInterfaceMethodsDesugarEnabled, boolean neverMarkAsUnusedDependency)

Method Summary

Modifier and Type	Method and Description
void	addToCollector(AndroidPackageableCollector collector) Add concrete resources to the given collector.
JavaAbiInfo	getAbiInfo()
Optional<BuildTarget>	getAbiJar()
BuildOutputInitializer<JavaLibrary.Data>	getBuildOutputInitializer()
JavaClassHashesProvider	getClassHashesProvider()
com.google.common.collect.ImmutableSortedMap<String,com.google.common.hash.HashCode>	getClassNamesToHashes()
com.google.common.collect.ImmutableSortedSet<SourcePath>	getCompileTimeClasspathSourcePaths()
java.util.function.Predicate<SourcePath>	getCoveredByDepFilePredicate(SourcePathResolverAdapter pathResolver) Returns a predicate that can tell whether a given path is covered by dep-file or not.
Set<BuildRule>	getDepsForTransitiveClasspathEntries()
java.util.function.Predicate<SourcePath>	getExistenceOfInterestPredicate(SourcePathResolverAdapter pathResolver) Returns a predicate that can tell whether the existence of a given path may be of interest to compiler.
SortedSet<BuildRule>	getExportedDeps()
SortedSet<BuildRule>	getExportedProvidedDeps()
Optional<SourcePath>	getGeneratedAnnotationSourcePath()
com.google.common.collect.ImmutableSet<SourcePath>	getImmediateClasspaths() Returns the classpaths for only this rule, not its deps.
com.google.common.collect.ImmutableList<SourcePath>	getInputsAfterBuildingLocally(BuildContext context, CellPathResolver cellPathResolver) Returns a list of source paths that were actually used for the rule.
com.google.common.collect.ImmutableSortedSet<SourcePath>	getJavaSrcs()
Optional<String>	getMavenCoords() Used to identify this library within a maven repository
com.google.common.collect.ImmutableSet<SourcePath>	getOutputClasspaths()
RulePipelineStateFactory<JavacPipelineState>	getPipelineStateFactory()
SupportsPipelining<JavacPipelineState>	getPreviousRuleInPipeline()
boolean	getRequiredForSourceOnlyAbi()
Iterable<AndroidPackageable>	getRequiredPackageables(BuildRuleResolver ruleResolver) Get the set of packagables that need to be included in any package that includes this object.
com.google.common.collect.ImmutableSortedSet<SourcePath>	getResources()
Optional<String>	getResourcesRoot()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
Optional<BuildTarget>	getSourceOnlyAbiJar()
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSortedSet<SourcePath>	getSources()
com.google.common.collect.ImmutableSortedSet<BuildTarget>	getTests()
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()
boolean	hasAnnotationProcessing()
JavaLibrary.Data	initializeFromDisk(SourcePathResolverAdapter pathResolver) Instructs this rule to report the ABI it has on disk as its current ABI.
void	invalidateInitializeFromDiskState()
boolean	isDesugarEnabled() Desugar support for java 8 features withing single class file.
boolean	isInterfaceMethodsDesugarEnabled() Desugar support for interface default and static methods.
boolean	neverMarkAsUnusedDependency()
static DefaultJavaLibraryRules.Builder	rulesBuilder(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, ToolchainProvider toolchainProvider, BuildRuleParams params, ActionGraphBuilder graphBuilder, ConfiguredCompilerFactory compilerFactory, JavaBuckConfig javaBuckConfig, JavaLibraryDescription.CoreArg args)
void	setJavaClassHashesProvider(JavaClassHashesProvider javaClassHashesProvider)
boolean	useDependencyFileRuleKeys()
boolean	useRulePipelining()

Methods inherited from class com.facebook.buck.rules.modern.PipelinedModernBuildRule

getPipelinedBuildSteps

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.jvm.core.HasMavenCoordinates

isMavenCoordsPresent

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

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

Methods inherited from interface com.facebook.buck.core.rules.pipeline.SupportsPipelining

isSupported

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

isSupported

Constructor Detail

DefaultJavaLibrary

protected DefaultJavaLibrary(BuildTarget buildTarget,
                             ProjectFilesystem projectFilesystem,
                             JarBuildStepsFactory jarBuildStepsFactory,
                             SourcePathRuleFinder ruleFinder,
                             Optional<SourcePath> proguardConfig,
                             SortedSet<BuildRule> firstOrderPackageableDeps,
                             com.google.common.collect.ImmutableSortedSet<BuildRule> fullJarExportedDeps,
                             com.google.common.collect.ImmutableSortedSet<BuildRule> fullJarProvidedDeps,
                             com.google.common.collect.ImmutableSortedSet<BuildRule> fullJarExportedProvidedDeps,
                             com.google.common.collect.ImmutableSortedSet<BuildRule> runtimeDeps,
                             @Nullable
                             BuildTarget abiJar,
                             @Nullable
                             BuildTarget sourceOnlyAbiJar,
                             Optional<String> mavenCoords,
                             com.google.common.collect.ImmutableSortedSet<BuildTarget> tests,
                             boolean requiredForSourceOnlyAbi,
                             JavaBuckConfig.UnusedDependenciesAction unusedDependenciesAction,
                             Optional<UnusedDependenciesFinderFactory> unusedDependenciesFinderFactory,
                             @Nullable
                             CalculateSourceAbi sourceAbi,
                             boolean isDesugarEnabled,
                             boolean isInterfaceMethodsDesugarEnabled,
                             boolean neverMarkAsUnusedDependency)

Method Detail

rulesBuilder

public static DefaultJavaLibraryRules.Builder rulesBuilder(BuildTarget buildTarget,
                                                           ProjectFilesystem projectFilesystem,
                                                           ToolchainProvider toolchainProvider,
                                                           BuildRuleParams params,
                                                           ActionGraphBuilder graphBuilder,
                                                           ConfiguredCompilerFactory compilerFactory,
                                                           @Nullable
                                                           JavaBuckConfig javaBuckConfig,
                                                           @Nullable
                                                           JavaLibraryDescription.CoreArg args)

getTests

public com.google.common.collect.ImmutableSortedSet<BuildTarget> getTests()

Specified by:

getTests in interface JavaLibraryWithTests

Returns:

A list of tests of this target.

isDesugarEnabled

public boolean isDesugarEnabled()

Description copied from interface: HasDesugarSupport

Desugar support for java 8 features withing single class file.

Such as Lambda expressions, Method references, Repeating annotations

Specified by:

isDesugarEnabled in interface HasDesugarSupport

isInterfaceMethodsDesugarEnabled

public boolean isInterfaceMethodsDesugarEnabled()

Description copied from interface: HasDesugarSupport

Desugar support for interface default and static methods.

Specified by:

isInterfaceMethodsDesugarEnabled in interface HasDesugarSupport

getRequiredForSourceOnlyAbi

public boolean getRequiredForSourceOnlyAbi()

Specified by:

getRequiredForSourceOnlyAbi in interface MaybeRequiredForSourceOnlyAbi

getJavaSrcs

public com.google.common.collect.ImmutableSortedSet<SourcePath> getJavaSrcs()

Specified by:

getJavaSrcs in interface JavaLibrary

getSources

public com.google.common.collect.ImmutableSortedSet<SourcePath> getSources()

Specified by:

getSources in interface HasSources

getResources

public com.google.common.collect.ImmutableSortedSet<SourcePath> getResources()

Specified by:

getResources in interface JavaLibrary

getResourcesRoot

public Optional<String> getResourcesRoot()

Specified by:

getResourcesRoot in interface JavaLibrary

hasAnnotationProcessing

public boolean hasAnnotationProcessing()

Specified by:

hasAnnotationProcessing in interface JavaLibrary

getDepsForTransitiveClasspathEntries

public Set<BuildRule> getDepsForTransitiveClasspathEntries()

Specified by:

getDepsForTransitiveClasspathEntries in interface HasClasspathDeps

Returns:

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

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.

getCompileTimeClasspathSourcePaths

public com.google.common.collect.ImmutableSortedSet<SourcePath> getCompileTimeClasspathSourcePaths()

getGeneratedAnnotationSourcePath

public Optional<SourcePath> getGeneratedAnnotationSourcePath()

Specified by:

getGeneratedAnnotationSourcePath in interface JavaLibrary

getExportedDeps

public SortedSet<BuildRule> getExportedDeps()

Specified by:

getExportedDeps in interface ExportDependencies

getExportedProvidedDeps

public SortedSet<BuildRule> getExportedProvidedDeps()

Specified by:

getExportedProvidedDeps in interface ExportDependencies

invalidateInitializeFromDiskState

public void invalidateInitializeFromDiskState()

Specified by:

invalidateInitializeFromDiskState in interface InitializableFromDisk<JavaLibrary.Data>

initializeFromDisk

public JavaLibrary.Data initializeFromDisk(SourcePathResolverAdapter pathResolver)
                                    throws IOException

Instructs this rule to report the ABI it has on disk as its current ABI.

Specified by:

initializeFromDisk in interface InitializableFromDisk<JavaLibrary.Data>

Parameters:

pathResolver -

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<JavaLibrary.Data> getBuildOutputInitializer()

Specified by:

getBuildOutputInitializer in interface InitializableFromDisk<JavaLibrary.Data>

getAbiJar

public final Optional<BuildTarget> getAbiJar()

Specified by:

getAbiJar in interface HasJavaAbi

Returns:

the SourcePath representing the ABI Jar for this rule.

getSourceOnlyAbiJar

public Optional<BuildTarget> getSourceOnlyAbiJar()

Specified by:

getSourceOnlyAbiJar in interface HasJavaAbi

getAbiInfo

public JavaAbiInfo getAbiInfo()

Specified by:

getAbiInfo in interface HasJavaAbi

getClassNamesToHashes

public com.google.common.collect.ImmutableSortedMap<String,com.google.common.hash.HashCode> getClassNamesToHashes()

Specified by:

getClassNamesToHashes in interface HasJavaClassHashes

Returns:

a (possibly empty) map of names of .class files in the output of this rule to SHA-1 hashes of their contents.

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<com.facebook.buck.jvm.java.DefaultJavaLibraryBuildable>

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.

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

getMavenCoords

public Optional<String> getMavenCoords()

Description copied from interface: HasMavenCoordinates

Used to identify this library within a maven repository

Specified by:

getMavenCoords in interface HasMavenCoordinates

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.

useDependencyFileRuleKeys

public boolean useDependencyFileRuleKeys()

Specified by:

useDependencyFileRuleKeys in interface SupportsDependencyFileRuleKey

getCoveredByDepFilePredicate

public java.util.function.Predicate<SourcePath> getCoveredByDepFilePredicate(SourcePathResolverAdapter pathResolver)

Description copied from interface: SupportsDependencyFileRuleKey

Returns a predicate that can tell whether a given path is covered by dep-file or not. Note that being covered by dep-file doesn't necessarily mean being present in the dep-file. A covered path will only be present if actually used and that's the core idea of dep-file keys.

I.e. this predicate should return true only for source paths that *may* be returned from SupportsDependencyFileRuleKey.getInputsAfterBuildingLocally(BuildContext, CellPathResolver). This information is used by the rule key builder to infer that inputs *not* in this list should be included unconditionally in the rule key. Inputs that *are* in this list should be included in the rule key if and only if they are actually being used for the rule. I.e. if they are present in the dep-file listed by SupportsDependencyFileRuleKey.getInputsAfterBuildingLocally(BuildContext, CellPathResolver).

Specified by:

getCoveredByDepFilePredicate in interface SupportsDependencyFileRuleKey

getExistenceOfInterestPredicate

public java.util.function.Predicate<SourcePath> getExistenceOfInterestPredicate(SourcePathResolverAdapter pathResolver)

Description copied from interface: SupportsDependencyFileRuleKey

Returns a predicate that can tell whether the existence of a given path may be of interest to compiler. If this predicate returns true, the path should be included in the rule key. Note that we only care about the existence here. The actual content of the file is not relevant.

The main purpose of this predicate is to support scenarios where compiler decides whether to use a file or not solely based on its path. Of course, if compiler decides to use the file, it should list it in the dep-file in which case both the path and the content will be included in the rule key. However, relying only on presence in the dep-file for such paths is not sufficient. The problem occurs when a new such file just gets added, in which case it won't be present in the dep-file produced in the previous build, and yet if we run a local build now the compiler may decide to use it. For that reason rule key needs to reflect existence of all such files and change when a such a file gets added or removed.

Specified by:

getExistenceOfInterestPredicate in interface SupportsDependencyFileRuleKey

getInputsAfterBuildingLocally

public com.google.common.collect.ImmutableList<SourcePath> getInputsAfterBuildingLocally(BuildContext context,
                                                                                         CellPathResolver cellPathResolver)

Description copied from interface: SupportsDependencyFileRuleKey

Returns a list of source paths that were actually used for the rule. This list comes from the dep-file produced by compiler.

Specified by:

getInputsAfterBuildingLocally in interface SupportsDependencyFileRuleKey

useRulePipelining

public boolean useRulePipelining()

Specified by:

useRulePipelining in interface SupportsPipelining<JavacPipelineState>

getPipelineStateFactory

public RulePipelineStateFactory<JavacPipelineState> getPipelineStateFactory()

Specified by:

getPipelineStateFactory in interface SupportsPipelining<JavacPipelineState>

getPreviousRuleInPipeline

@Nullable
public SupportsPipelining<JavacPipelineState> getPreviousRuleInPipeline()

Specified by:

getPreviousRuleInPipeline in interface SupportsPipelining<JavacPipelineState>

getClassHashesProvider

public JavaClassHashesProvider getClassHashesProvider()

Specified by:

getClassHashesProvider in interface HasJavaClassHashes

setJavaClassHashesProvider

public void setJavaClassHashesProvider(JavaClassHashesProvider javaClassHashesProvider)

neverMarkAsUnusedDependency

public boolean neverMarkAsUnusedDependency()

Specified by:

neverMarkAsUnusedDependency in interface JavaLibrary