Package net.covers1624.coffeegrinder.debug

Class Step

java.lang.Object
net.covers1624.coffeegrinder.debug.Step
All Implemented Interfaces:
AutoCloseable
public class Step extends Object implements AutoCloseable
Created by covers1624 on 13/5/21.

  • Method Details

    • getName

      public 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 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 List<Step> getChildren()
      Gets the children for this step.
      Returns:
      An Immutable view of children.

    • getPreStepContent

      @Nullable public @Nullable 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 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 AutoCloseable