com.facebook.buck.core.build.event

Class BuildRuleEvent

java.lang.Object

com.facebook.buck.event.AbstractBuckEvent

com.facebook.buck.core.build.event.BuildRuleEvent

All Implemented Interfaces:

BuckEvent, BuckEventExternalInterface, WorkAdvanceEvent

Direct Known Subclasses:

BuildRuleEvent.BeginningBuildRuleEvent, BuildRuleEvent.EndingBuildRuleEvent

public abstract class BuildRuleEvent
extends AbstractBuckEvent
implements WorkAdvanceEvent

Base class for events about build rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildRuleEvent.BeginningBuildRuleEvent A BuildRuleEvent that denotes beginning of computation for a particular BuildRule.
static class	BuildRuleEvent.EndingBuildRuleEvent A BuildRuleEvent that denotes ending of computation for a particular BuildRule.
static class	BuildRuleEvent.Finished Marks the end of processing a build rule.
static class	BuildRuleEvent.FinishedRuleKeyCalc Marks the completion of processing a rule to calculate its rule key.
static class	BuildRuleEvent.Resumed Marks the continuation of processing a rule.
static class	BuildRuleEvent.Started Marks the start of processing a build rule.
static class	BuildRuleEvent.StartedRuleKeyCalc Marks the start of processing a rule to calculate its rule key.
static class	BuildRuleEvent.Suspended Marks a rule is suspended from processing.
static class	BuildRuleEvent.WillBuildLocally Denotes that a particular build rule will be built locally.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClockDuration	duration Accumulated duration of work spent on this rule up until this event occurred.

Fields inherited from interface com.facebook.buck.event.external.events.BuckEventExternalInterface

BUILD_FINISHED, BUILD_REPORT, BUILD_STARTED, BUILD_STATUS_EVENT, CACHE_RATE_STATS_UPDATE_EVENT, INDIVIDUAL_TEST_AWAITING_RESULTS, INSTALL_STARTED, PARSE_FINISHED, PARSE_STARTED, PROJECT_GENERATION_FINISHED, PROJECT_GENERATION_STARTED, TEST_RUN_STARTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuildRuleEvent(EventKey eventKey, BuildRule rule)

Method Summary

Modifier and Type	Method and Description
static BuildRuleEvent.Finished	finished(BuildRuleEvent.BeginningBuildRuleEvent beginning, BuildRuleKeys ruleKeys, BuildRuleStatus status, CacheResult cacheResult, Optional<BuildId> origin, Optional<BuildRuleSuccessType> successType, UploadToCacheResultType uploadToCacheResultType, Optional<com.google.common.hash.HashCode> outputHash, Optional<Long> outputSize, Optional<BuildRuleDiagnosticData> diagnosticData, Optional<ManifestFetchResult> manifestFetchResult, Optional<ManifestStoreResult> manifestStoreResult, Optional<Pair<Long,Long>> ruleKeyCacheCheckTimestamps, Optional<Pair<Long,Long>> inputRuleKeyCacheCheckTimestamps, Optional<Pair<Long,Long>> manifestRuleKeyCacheCheckTimestamps, Optional<Pair<Long,Long>> buildTimestamps, Optional<String> strategyResult)
BuildRule	getBuildRule()
ClockDuration	getDuration()
String	getEventName()
String	getValueString()
abstract boolean	isRuleRunningAfterThisEvent()
static BuildRuleEvent.Resumed	resumed(BuildRule rule, BuildRuleDurationTracker tracker, RuleKeyFactory<RuleKey> ruleKeyFactory)
static BuildRuleEvent.FinishedRuleKeyCalc	ruleKeyCalculationFinished(BuildRuleEvent.StartedRuleKeyCalc started, RuleKeyFactory<RuleKey> ruleKeyFactory)
static Scope	ruleKeyCalculationScope(BuckEventBus eventBus, BuildRule rule, BuildRuleDurationTracker tracker, RuleKeyFactory<RuleKey> ruleKeyFactory)
static BuildRuleEvent.StartedRuleKeyCalc	ruleKeyCalculationStarted(BuildRule rule, BuildRuleDurationTracker tracker)
static BuildRuleEvent.Started	started(BuildRule rule, BuildRuleDurationTracker tracker)
static BuildRuleEvent.Suspended	suspended(BuildRuleEvent.BeginningBuildRuleEvent beginning, RuleKeyFactory<RuleKey> ruleKeyFactory)
static BuildRuleEvent.WillBuildLocally	willBuildLocally(BuildRule rule)

Methods inherited from class com.facebook.buck.event.AbstractBuckEvent

configure, equals, getBuildId, getEventKey, getNanoTime, getThreadId, getThreadUserNanoTime, getTimestampMillis, hashCode, isConfigured, isRelatedTo, toLogMessage, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.event.BuckEvent

configure, getBuildId, getEventKey, getNanoTime, getThreadId, getThreadUserNanoTime, isConfigured, isRelatedTo, toLogMessage

Methods inherited from interface com.facebook.buck.event.external.events.BuckEventExternalInterface

getTimestampMillis, storeLastInstanceAndReplayForNewClients

Field Detail

duration

@Nullable
protected ClockDuration duration

Accumulated duration of work spent on this rule up until this event occurred.

Constructor Detail

BuildRuleEvent

protected BuildRuleEvent(EventKey eventKey,
                         BuildRule rule)

Method Detail

getBuildRule

public BuildRule getBuildRule()

getDuration

public ClockDuration getDuration()

getValueString

public String getValueString()

Specified by:

getValueString in class AbstractBuckEvent

getEventName

public final String getEventName()

Specified by:

getEventName in interface BuckEventExternalInterface

Returns:

the type of the event.

isRuleRunningAfterThisEvent

public abstract boolean isRuleRunningAfterThisEvent()

started

public static BuildRuleEvent.Started started(BuildRule rule,
                                             BuildRuleDurationTracker tracker)

finished

public static BuildRuleEvent.Finished finished(BuildRuleEvent.BeginningBuildRuleEvent beginning,
                                               BuildRuleKeys ruleKeys,
                                               BuildRuleStatus status,
                                               CacheResult cacheResult,
                                               Optional<BuildId> origin,
                                               Optional<BuildRuleSuccessType> successType,
                                               UploadToCacheResultType uploadToCacheResultType,
                                               Optional<com.google.common.hash.HashCode> outputHash,
                                               Optional<Long> outputSize,
                                               Optional<BuildRuleDiagnosticData> diagnosticData,
                                               Optional<ManifestFetchResult> manifestFetchResult,
                                               Optional<ManifestStoreResult> manifestStoreResult,
                                               Optional<Pair<Long,Long>> ruleKeyCacheCheckTimestamps,
                                               Optional<Pair<Long,Long>> inputRuleKeyCacheCheckTimestamps,
                                               Optional<Pair<Long,Long>> manifestRuleKeyCacheCheckTimestamps,
                                               Optional<Pair<Long,Long>> buildTimestamps,
                                               Optional<String> strategyResult)

ruleKeyCalculationStarted

public static BuildRuleEvent.StartedRuleKeyCalc ruleKeyCalculationStarted(BuildRule rule,
                                                                          BuildRuleDurationTracker tracker)

ruleKeyCalculationFinished

public static BuildRuleEvent.FinishedRuleKeyCalc ruleKeyCalculationFinished(BuildRuleEvent.StartedRuleKeyCalc started,
                                                                            RuleKeyFactory<RuleKey> ruleKeyFactory)

suspended

public static BuildRuleEvent.Suspended suspended(BuildRuleEvent.BeginningBuildRuleEvent beginning,
                                                 RuleKeyFactory<RuleKey> ruleKeyFactory)

resumed

public static BuildRuleEvent.Resumed resumed(BuildRule rule,
                                             BuildRuleDurationTracker tracker,
                                             RuleKeyFactory<RuleKey> ruleKeyFactory)

willBuildLocally

public static BuildRuleEvent.WillBuildLocally willBuildLocally(BuildRule rule)

ruleKeyCalculationScope

public static Scope ruleKeyCalculationScope(BuckEventBus eventBus,
                                            BuildRule rule,
                                            BuildRuleDurationTracker tracker,
                                            RuleKeyFactory<RuleKey> ruleKeyFactory)