com.facebook.buck.event

Class AbstractBuckEvent

java.lang.Object

com.facebook.buck.event.AbstractBuckEvent

All Implemented Interfaces:

BuckEvent, BuckEventExternalInterface

Direct Known Subclasses:

ActionGraphEvent, ActionGraphPerfStatEvent, AnnotationProcessingEvent, ArtifactCacheConnectEvent, ArtifactCacheEvent, ArtifactCompressionEvent, BuckInitializationDurationEvent, BuildEvent, BuildRuleEvent, BuildRuleEvent.WillBuildLocally, BuildRuleExecutionEvent.Event, CacheCountersSummaryEvent, CacheRateStatsKeeper.CacheRateStatsUpdateEvent, CacheStatsEvent, CasBlobDownloadEvent, CasBlobUploadEvent, CommandEvent, CompilerErrorEvent, CompilerPluginDurationEvent, ConsoleEvent, CounterRegistry.AsyncCounterRegistrationEvent, CountersSnapshotEvent, DaemonEvent, DownloadEvent, DownloadProgressEvent, ExperimentEvent, ExternalTestRunEvent, ExternalTestSpecCalculationEvent, FastVersionControlStatsEvent, FileHashCacheEvent, FinalizingBuildRuleEvent, FlushConsoleEvent, GCCollectionEvent, HttpArtifactCacheEvent.Shutdown, HybridLocalEvent, IndividualTestEvent, InstallEvent, JavacPhaseEvent, LeafEvents.SimpleLeafEvent, LoadBalancedServiceEvent, LoadBalancerPingEvent, LocalFallbackEvent, NetworkEvent, NetworkInfo.Event, ParseBuckFileEvent, ParseBuckProfilerReportEvent, ParseEvent, ParsingEvent, PerfStatsTracking.PerfStatsEvent, PerfTimesEventListener.PerfTimesEvent, ProcessTracker.ProcessResourceConsumptionEvent, ProgressEvent, ProjectBuildFileParseEvents, ProjectGenerationEvent, RemoteBuildRuleExecutionEvent, RemoteExecutionActionEvent, RemoteExecutionSessionEvent, RuleKeyCacheResultEvent, RuleKeyCalculationEvent.Event, ServerHealthManagerEvent, SimplePerfEvent, StartActivityEvent, StepEvent, TestRuleEvent, TestRunEvent, TestStatusMessageEvent, TestSummaryEvent, UninstallEvent, VersionControlStatsEvent, VersionedTargetGraphEvent, WatchmanDiagnosticEvent, WatchmanStatusEvent

public abstract class AbstractBuckEvent
extends Object
implements BuckEvent

Base class for all build events. Using this makes it easy to add a wildcard listener to the event bus.

Field Summary

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	AbstractBuckEvent(EventKey eventKey)

Method Summary

Modifier and Type	Method and Description
void	configure(long timestampMillis, long nanoTime, long threadUserNanoTime, long threadId, BuildId buildId) Method to configure an event before posting it to the BuckEventBus.
boolean	equals(Object o) The default implementation of equals checks to see if two events are related, are on the same thread, and are the same concrete class.
BuildId	getBuildId()
EventKey	getEventKey()
long	getNanoTime()
long	getThreadId()
long	getThreadUserNanoTime()
long	getTimestampMillis()
protected abstract String	getValueString()
int	hashCode()
boolean	isConfigured()
boolean	isRelatedTo(BuckEvent event)
String	toLogMessage()
String	toString()

Methods inherited from class java.lang.Object

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

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

getEventName, storeLastInstanceAndReplayForNewClients

Constructor Detail

AbstractBuckEvent

protected AbstractBuckEvent(EventKey eventKey)

Method Detail

configure

public void configure(long timestampMillis,
                      long nanoTime,
                      long threadUserNanoTime,
                      long threadId,
                      BuildId buildId)

Method to configure an event before posting it to the BuckEventBus. This method should only be invoked once per event, and only by the BuckEventBus in production code.

Specified by:

configure in interface BuckEvent

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface BuckEvent

getTimestampMillis

public long getTimestampMillis()

Specified by:

getTimestampMillis in interface BuckEventExternalInterface

Returns:

the time at which the event has been created, in milliseconds.

getNanoTime

public long getNanoTime()

Specified by:

getNanoTime in interface BuckEvent

getThreadUserNanoTime

public long getThreadUserNanoTime()

Specified by:

getThreadUserNanoTime in interface BuckEvent

toLogMessage

public String toLogMessage()

Specified by:

toLogMessage in interface BuckEvent

getThreadId

public long getThreadId()

Specified by:

getThreadId in interface BuckEvent

getBuildId

public BuildId getBuildId()

Specified by:

getBuildId in interface BuckEvent

Returns:

an identifier that distinguishes the build with which this event is associated.

getEventKey

public final EventKey getEventKey()

Specified by:

getEventKey in interface BuckEvent

Returns:

key used to determine whether this event is related to another event.

isRelatedTo

public final boolean isRelatedTo(BuckEvent event)

Specified by:

isRelatedTo in interface BuckEvent

Returns:

Whether or not this event is related to another event. Events are related if they pertain to the same event, for example if they are measuring the start and stop of some phase. For example,

   
    (CommandEvent.started("build")).isRelatedTo(CommandEvent.finished("build")) == true
    (CommandEvent.started("build")).isRelatedTo(CommandEvent.started("build")) == true
    (CommandEvent.started("build")).isRelatedTo(CommandEvent.finished("install")) == false
   
 

getValueString

protected abstract String getValueString()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

The default implementation of equals checks to see if two events are related, are on the same thread, and are the same concrete class. Subclasses therefore can simply override isRelatedTo, and the equals method will work correctly.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object