com.facebook.buck.jvm.java

Class MavenUberJar

java.lang.Object

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

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

com.facebook.buck.jvm.java.MavenUberJar

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, HasMavenCoordinates, MavenPublishable, Comparable<BuildRule>

public class MavenUberJar
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements MavenPublishable

A BuildRule used to have the provided JavaLibrary published to a maven repository

See Also:

create(com.facebook.buck.jvm.core.JavaLibrary, com.facebook.buck.core.model.BuildTarget, com.facebook.buck.io.filesystem.ProjectFilesystem, com.facebook.buck.core.rules.BuildRuleParams, java.util.Optional<java.lang.String>, java.util.Optional<com.facebook.buck.core.sourcepath.SourcePath>)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MavenUberJar.SourceJar

Method Summary

Modifier and Type	Method and Description
static MavenUberJar	create(JavaLibrary rootRule, BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, Optional<String> mavenCoords, Optional<SourcePath> mavenPomTemplate) Will traverse transitive dependencies of rootRule, separating those that do and don't have maven coordinates.
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Optional<String>	getMavenCoords() Used to identify this library within a maven repository
Iterable<HasMavenCoordinates>	getMavenDeps() When published, these will be listed in pom.xml as dependencies
Iterable<BuildRule>	getPackagedDependencies() When published, these will be included in the artifact.
Optional<SourcePath>	getPomTemplate()
SourcePath	getSourcePathToOutput()

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

Method Detail

create

public static MavenUberJar create(JavaLibrary rootRule,
                                  BuildTarget buildTarget,
                                  ProjectFilesystem projectFilesystem,
                                  BuildRuleParams params,
                                  Optional<String> mavenCoords,
                                  Optional<SourcePath> mavenPomTemplate)

Will traverse transitive dependencies of rootRule, separating those that do and don't have maven coordinates. Those that do will be considered maven-external dependencies. They will be returned by getMavenDeps() and will end up being specified as dependencies in pom.xml. Others will be packaged in the same jar as if they are just a part of the one published item.

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

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

getPomTemplate

public Optional<SourcePath> getPomTemplate()

Specified by:

getPomTemplate in interface MavenPublishable

Returns:

A template for the pom.xml to be generated when publishing this artifact.

getMavenDeps

public Iterable<HasMavenCoordinates> getMavenDeps()

Description copied from interface: MavenPublishable

When published, these will be listed in pom.xml as dependencies

Specified by:

getMavenDeps in interface MavenPublishable

getPackagedDependencies

public Iterable<BuildRule> getPackagedDependencies()

Description copied from interface: MavenPublishable

When published, these will be included in the artifact. This, MavenPublishable.getMavenDeps(), and the transitive dependencies of those maven deps would form the complete set of transitive dependencies for the artifact.

Specified by:

getPackagedDependencies in interface MavenPublishable