net.covers1624.coffeegrinder.debug

Class Step

java.lang.Object

net.covers1624.coffeegrinder.debug.Step

All Implemented Interfaces:

java.lang.AutoCloseable

public class Step
extends java.lang.Object
implements java.lang.AutoCloseable

Created by covers1624 on 13/5/21.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Step.Status
static class	Step.StepContextType
static class	Step.StepType

Method Summary

Modifier and Type	Method and Description
void	close()
@Nullable java.lang.Throwable	getCaughtException() Gets the exception that was thrown during the execution of this step.
java.util.List<Step>	getChildren() Gets the children for this step.
Step.StepContextType	getContextType()
long	getDuration()
long	getEndTime()
int	getId()
java.lang.String	getName() Gets a short descriptive name for this step.
@Nullable Step	getParent() Gets the parent for this step.
@Nullable java.lang.String	getPostStepContent() The content provided for this step after action was taken by the step.
@Nullable java.lang.String	getPreStepContent() The content provided for this step before any action was taken by the step.
long	getStartTime()
Step.Status	getStatus() Gets the status of this Step.
Step.StepType	getType() Gets this Steps type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Gets a short descriptive name for this step. Usually the Transformer/method name/class name

Returns:

The name.

getId

public int getId()

getType

public Step.StepType getType()

Gets this Steps type.

Returns:

The type of Step this is.

getContextType

public Step.StepContextType getContextType()

getStatus

public Step.Status getStatus()

Gets the status of this Step.

Returns:

The status.

getCaughtException

@Nullable
public @Nullable java.lang.Throwable getCaughtException()

Gets the exception that was thrown during the execution of this step.

Returns:

The exception or null if the step executed successfully.

getParent

@Nullable
public @Nullable Step getParent()

Gets the parent for this step. This will be null for the root node.

Returns:

The parent step, or null for the root node.

getChildren

public java.util.List<Step> getChildren()

Gets the children for this step.

Returns:

An Immutable view of children.

getPreStepContent

@Nullable
public @Nullable java.lang.String getPreStepContent()

The content provided for this step before any action was taken by the step.

Returns:

The content. May return null if the Stepper responsible does not support content.

getPostStepContent

@Nullable
public @Nullable java.lang.String getPostStepContent()

The content provided for this step after action was taken by the step.

Returns:

The content. May return null if the Stepper responsible does not support content.

getStartTime

public long getStartTime()

Returns:

The time in nanoseconds this step started.

getEndTime

public long getEndTime()

Returns:

The time in nanoseconds this step ended.

getDuration

public long getDuration()

Returns:

The duration in nanoseconds this step took.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable