com.facebook.buck.jvm.java

Class PrebuiltJar

java.lang.Object

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

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

com.facebook.buck.jvm.java.PrebuiltJar

All Implemented Interfaces:

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

public class PrebuiltJar
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements AndroidPackageable, ExportDependencies, InitializableFromDisk<JavaLibrary.Data>, JavaLibrary, MaybeRequiredForSourceOnlyAbi, SupportsInputBasedRuleKey

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

Constructor and Description
PrebuiltJar(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, SourcePathResolverAdapter resolver, SourcePath binaryJar, Optional<SourcePath> sourceJar, Optional<SourcePath> gwtJar, Optional<String> javadocUrl, Optional<String> mavenCoords, boolean provided, boolean requiredForSourceOnlyAbi, boolean generateAbi, 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()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
JavaClassHashesProvider	getClassHashesProvider()
com.google.common.collect.ImmutableSortedMap<String,com.google.common.hash.HashCode>	getClassNamesToHashes()
Set<BuildRule>	getDepsForTransitiveClasspathEntries()
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.
Optional<String>	getJavadocUrl()
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()
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<SourcePath>	getSourceJar()
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSortedSet<SourcePath>	getSources()
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()
boolean	hasAnnotationProcessing()
JavaLibrary.Data	initializeFromDisk(SourcePathResolverAdapter pathResolver)
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()

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.jvm.core.HasJavaAbi

getSourceOnlyAbiJar

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

isMavenCoordsPresent

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

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

inputBasedRuleKeyIsEnabled, isSupported

Constructor Detail

PrebuiltJar

public PrebuiltJar(BuildTarget buildTarget,
                   ProjectFilesystem projectFilesystem,
                   BuildRuleParams params,
                   SourcePathResolverAdapter resolver,
                   SourcePath binaryJar,
                   Optional<SourcePath> sourceJar,
                   Optional<SourcePath> gwtJar,
                   Optional<String> javadocUrl,
                   Optional<String> mavenCoords,
                   boolean provided,
                   boolean requiredForSourceOnlyAbi,
                   boolean generateAbi,
                   boolean neverMarkAsUnusedDependency)

Method Detail

getRequiredForSourceOnlyAbi

public boolean getRequiredForSourceOnlyAbi()

Specified by:

getRequiredForSourceOnlyAbi in interface MaybeRequiredForSourceOnlyAbi

getSourceJar

public Optional<SourcePath> getSourceJar()

getJavadocUrl

public Optional<String> getJavadocUrl()

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

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.

invalidateInitializeFromDiskState

public void invalidateInitializeFromDiskState()

Specified by:

invalidateInitializeFromDiskState in interface InitializableFromDisk<JavaLibrary.Data>

initializeFromDisk

public JavaLibrary.Data initializeFromDisk(SourcePathResolverAdapter pathResolver)
                                    throws IOException

Specified by:

initializeFromDisk in interface InitializableFromDisk<JavaLibrary.Data>

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>

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.

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

getExportedDeps

public SortedSet<BuildRule> getExportedDeps()

Specified by:

getExportedDeps in interface ExportDependencies

getExportedProvidedDeps

public SortedSet<BuildRule> getExportedProvidedDeps()

Specified by:

getExportedProvidedDeps in interface ExportDependencies

getGeneratedAnnotationSourcePath

public Optional<SourcePath> getGeneratedAnnotationSourcePath()

Specified by:

getGeneratedAnnotationSourcePath in interface JavaLibrary

hasAnnotationProcessing

public boolean hasAnnotationProcessing()

Specified by:

hasAnnotationProcessing in interface JavaLibrary

neverMarkAsUnusedDependency

public boolean neverMarkAsUnusedDependency()

Specified by:

neverMarkAsUnusedDependency in interface JavaLibrary

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

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.

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getAbiInfo

public JavaAbiInfo getAbiInfo()

Specified by:

getAbiInfo in interface HasJavaAbi

getAbiJar

public Optional<BuildTarget> getAbiJar()

Specified by:

getAbiJar in interface HasJavaAbi

Returns:

the SourcePath representing the ABI Jar for this rule.

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

getClassHashesProvider

public JavaClassHashesProvider getClassHashesProvider()

Specified by:

getClassHashesProvider in interface HasJavaClassHashes