com.facebook.buck.jvm.java

Class JarFattener

java.lang.Object

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

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

com.facebook.buck.jvm.java.JarFattener

All Implemented Interfaces:

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

public class JarFattener
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements BinaryBuildRule, HasClasspathEntries

Build a fat JAR that packages an inner JAR along with any required native libraries.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAT_JAR_MAIN_SRC_RESOURCE
static com.google.common.collect.ImmutableList<String>	FAT_JAR_SRC_RESOURCES

Constructor Summary

Constructors

Constructor and Description
JarFattener(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, Javac javac, JavacOptions javacOptions, SourcePath innerJar, JavaBinary innerJarRule, com.google.common.collect.ImmutableMap<String,SourcePath> nativeLibraries, Tool javaRuntimeLauncher)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
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.ImmutableMap<String,SourcePath>	getNativeLibraries()
com.google.common.collect.ImmutableSet<SourcePath>	getOutputClasspaths()
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()
void	updateBuildRuleResolver(BuildRuleResolver ruleResolver) Updates the BuildRuleResolver and associated objects for this build rule.

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

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, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

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

getType

Field Detail

FAT_JAR_SRC_RESOURCES

public static final com.google.common.collect.ImmutableList<String> FAT_JAR_SRC_RESOURCES

FAT_JAR_MAIN_SRC_RESOURCE

public static final String FAT_JAR_MAIN_SRC_RESOURCE

See Also:

Constant Field Values

Constructor Detail

JarFattener

public JarFattener(BuildTarget buildTarget,
                   ProjectFilesystem projectFilesystem,
                   BuildRuleParams params,
                   Javac javac,
                   JavacOptions javacOptions,
                   SourcePath innerJar,
                   JavaBinary innerJarRule,
                   com.google.common.collect.ImmutableMap<String,SourcePath> nativeLibraries,
                   Tool javaRuntimeLauncher)

Method Detail

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

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

getNativeLibraries

public com.google.common.collect.ImmutableMap<String,SourcePath> getNativeLibraries()

updateBuildRuleResolver

public void updateBuildRuleResolver(BuildRuleResolver ruleResolver)

Description copied from interface: BuildRule

Updates the BuildRuleResolver and associated objects for this build rule.

Build rules sometimes hold field references to build rule resolvers. If this build rule is to be cached, it must update its BuildRuleResolver when a new action graph is constructed to avoid leaking the entire action graph it was originally associated with.

Specified by:

updateBuildRuleResolver in interface BuildRule

Overrides:

updateBuildRuleResolver in class AbstractBuildRule

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.