com.facebook.buck.jvm.java

Class Javadoc

java.lang.Object

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

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

com.facebook.buck.jvm.java.Javadoc

All Implemented Interfaces:

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

public class Javadoc
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements MavenPublishable

Field Summary

Fields

Modifier and Type	Field and Description
static Flavor	DOC_JAR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Javadoc(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams buildRuleParams, Optional<String> mavenCoords, Optional<SourcePath> mavenPomTemplate, Iterable<HasMavenCoordinates> mavenDeps, com.google.common.collect.ImmutableSet<SourcePath> sources)

Method Summary

Modifier and Type	Method and Description
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

Field Detail

DOC_JAR

public static final Flavor DOC_JAR

Constructor Detail

Javadoc

protected Javadoc(BuildTarget buildTarget,
                  ProjectFilesystem projectFilesystem,
                  BuildRuleParams buildRuleParams,
                  Optional<String> mavenCoords,
                  Optional<SourcePath> mavenPomTemplate,
                  Iterable<HasMavenCoordinates> mavenDeps,
                  com.google.common.collect.ImmutableSet<SourcePath> sources)

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

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

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

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.