com.facebook.buck.step

Class StepEvent

java.lang.Object

com.facebook.buck.event.AbstractBuckEvent

com.facebook.buck.step.StepEvent

All Implemented Interfaces:

BuckEvent, BuckEventExternalInterface, StepEventExternalInterface, LeafEvent, WorkAdvanceEvent

Direct Known Subclasses:

StepEvent.Finished, StepEvent.Started

public abstract class StepEvent
extends AbstractBuckEvent
implements LeafEvent, StepEventExternalInterface, WorkAdvanceEvent

Base class for events about steps.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StepEvent.Finished
static class	StepEvent.Started

Field Summary

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

STEP_FINISHED, STEP_STARTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StepEvent(String shortName, String description, UUID uuid)

Method Summary

Modifier and Type	Method and Description
static StepEvent.Finished	finished(StepEvent.Started started, int exitCode)
String	getCategory()
String	getDescription()
String	getShortStepName()
protected UUID	getUuid()
protected String	getValueString()
static StepEvent.Started	started(String shortName, String description, UUID uuid)

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

Constructor Detail

StepEvent

protected StepEvent(String shortName,
                    String description,
                    UUID uuid)

Method Detail

getShortStepName

public String getShortStepName()

Specified by:

getShortStepName in interface StepEventExternalInterface

Returns:

the step name.

getDescription

public String getDescription()

Specified by:

getDescription in interface StepEventExternalInterface

Returns:

the description of the step, usually the command itself.

getUuid

protected UUID getUuid()

getCategory

public String getCategory()

Specified by:

getCategory in interface LeafEvent

Returns:

The category time spent in this event should be accounted under.

getValueString

protected String getValueString()

Specified by:

getValueString in class AbstractBuckEvent

started

public static StepEvent.Started started(String shortName,
                                        String description,
                                        UUID uuid)

finished

public static StepEvent.Finished finished(StepEvent.Started started,
                                          int exitCode)