com.facebook.buck.core.build.engine

Enum BuildRuleSuccessType

java.lang.Object

java.lang.Enum<BuildRuleSuccessType>

com.facebook.buck.core.build.engine.BuildRuleSuccessType

All Implemented Interfaces:

Serializable, Comparable<BuildRuleSuccessType>

public enum BuildRuleSuccessType
extends Enum<BuildRuleSuccessType>

Token provided by the result of BuildEngine.build(BuildEngineBuildContext, ExecutionContext, BuildRule), demonstrating that the associated BuildRule was built successfully.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUILT_LOCALLY Built by executing the Steps for the rule.
FETCHED_FROM_CACHE Fetched via the ArtifactCache.
FETCHED_FROM_CACHE_INPUT_BASED Fetched via the ArtifactCache using an input-based rule key.
FETCHED_FROM_CACHE_MANIFEST_BASED Fetched via the ArtifactCache using an input-based rule key.
MATCHING_DEP_FILE_RULE_KEY Computed dep-file RuleKey matches the one on disk
MATCHING_INPUT_BASED_RULE_KEY Computed input-based RuleKey matches the one on disk.
MATCHING_RULE_KEY Computed RuleKey matches the one on disk.

Method Summary

Modifier and Type	Method and Description
String	getShortDescription()
boolean	outputsHaveChanged()
boolean	shouldClearAndOverwriteMetadataOnDisk()
boolean	shouldUploadResultingArtifact()
boolean	shouldWriteRecordedMetadataToDiskAfterBuilding()
static BuildRuleSuccessType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuildRuleSuccessType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BUILT_LOCALLY

public static final BuildRuleSuccessType BUILT_LOCALLY

Built by executing the Steps for the rule.

FETCHED_FROM_CACHE

public static final BuildRuleSuccessType FETCHED_FROM_CACHE

Fetched via the ArtifactCache.

FETCHED_FROM_CACHE_INPUT_BASED

public static final BuildRuleSuccessType FETCHED_FROM_CACHE_INPUT_BASED

Fetched via the ArtifactCache using an input-based rule key.

FETCHED_FROM_CACHE_MANIFEST_BASED

public static final BuildRuleSuccessType FETCHED_FROM_CACHE_MANIFEST_BASED

Fetched via the ArtifactCache using an input-based rule key.

MATCHING_RULE_KEY

public static final BuildRuleSuccessType MATCHING_RULE_KEY

Computed RuleKey matches the one on disk.

MATCHING_INPUT_BASED_RULE_KEY

public static final BuildRuleSuccessType MATCHING_INPUT_BASED_RULE_KEY

Computed input-based RuleKey matches the one on disk.

MATCHING_DEP_FILE_RULE_KEY

public static final BuildRuleSuccessType MATCHING_DEP_FILE_RULE_KEY

Computed dep-file RuleKey matches the one on disk

Method Detail

values

public static BuildRuleSuccessType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BuildRuleSuccessType c : BuildRuleSuccessType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuildRuleSuccessType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

shouldWriteRecordedMetadataToDiskAfterBuilding

public boolean shouldWriteRecordedMetadataToDiskAfterBuilding()

shouldClearAndOverwriteMetadataOnDisk

public boolean shouldClearAndOverwriteMetadataOnDisk()

shouldUploadResultingArtifact

public boolean shouldUploadResultingArtifact()

outputsHaveChanged

public boolean outputsHaveChanged()

getShortDescription

public String getShortDescription()