com.facebook.buck.jvm.java

Class JavaBinary

java.lang.Object

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

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

com.facebook.buck.jvm.java.JavaBinary

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, HasRuntimeDeps, BuildRule, HasNameAndType, BinaryBuildRule, HasClasspathDeps, HasClasspathEntries, Comparable<BuildRule>

public class JavaBinary
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements BinaryBuildRule, HasClasspathDeps, HasClasspathEntries, HasRuntimeDeps

Constructor Summary

Constructors

Constructor and Description

JavaBinary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, Tool javaRuntimeLauncher, String mainClass, SourcePath manifestFile, boolean mergeManifests, boolean disallowAllDuplicates, Path metaInfDirectory, com.google.common.collect.ImmutableSet<Pattern> blacklist, com.google.common.collect.ImmutableSet<JavaLibrary> transitiveClasspathDeps, com.google.common.collect.ImmutableSet<SourcePath> transitiveClasspaths, boolean cache, Level duplicatesLogLevel)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Set<BuildRule>	getDepsForTransitiveClasspathEntries()
Tool	getExecutableCommand(OutputLabel outputLabel) Command to execute the output of this rule.
com.google.common.collect.ImmutableSet<SourcePath>	getImmediateClasspaths() Returns the classpaths for only this rule, not its deps.
com.google.common.collect.ImmutableSet<SourcePath>	getOutputClasspaths()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()
boolean	isCacheable() Whether this BuildRule can be cached.

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, 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, getBuildDeps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, 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

JavaBinary

public JavaBinary(BuildTarget buildTarget,
                  ProjectFilesystem projectFilesystem,
                  BuildRuleParams params,
                  Tool javaRuntimeLauncher,
                  @Nullable
                  String mainClass,
                  @Nullable
                  SourcePath manifestFile,
                  boolean mergeManifests,
                  boolean disallowAllDuplicates,
                  @Nullable
                  Path metaInfDirectory,
                  com.google.common.collect.ImmutableSet<Pattern> blacklist,
                  com.google.common.collect.ImmutableSet<JavaLibrary> transitiveClasspathDeps,
                  com.google.common.collect.ImmutableSet<SourcePath> transitiveClasspaths,
                  boolean cache,
                  Level duplicatesLogLevel)

Method Detail

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

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.

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getExecutableCommand

public Tool getExecutableCommand(OutputLabel outputLabel)

Description copied from interface: BinaryBuildRule

Command to execute the output of this rule.

Specified by:

getExecutableCommand in interface BinaryBuildRule

Parameters:

outputLabel - associated with the executable

isCacheable

public boolean isCacheable()

Description copied from interface: BuildRule

Whether this BuildRule can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

Uncached rules are not always rebuilt, however, as long as the existing on-disk representation is up to date. This means that these rules can take advantage of SupportsInputBasedRuleKey to prevent rebuilding.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule

getDepsForTransitiveClasspathEntries

public Set<BuildRule> getDepsForTransitiveClasspathEntries()

Specified by:

getDepsForTransitiveClasspathEntries in interface HasClasspathDeps

Returns:

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

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps