net.covers1624.coffeegrinder.debug

Class DebugStepper

java.lang.Object

net.covers1624.coffeegrinder.debug.DebugStepper

All Implemented Interfaces:

Stepper

public class DebugStepper
extends java.lang.Object
implements Stepper

A content tracing Stepper implementation.

Created by covers1624 on 13/5/21.

Constructor Summary

Constructors

Constructor and Description
DebugStepper(DebugPrintOptions opts, int stopAtStep)

Method Summary

Modifier and Type	Method and Description
void	except(java.lang.Throwable e) Marks the Stepper as having caught an exception.
DebugPrintOptions	getOpts() Get the DebugPrintOptions for this stepper.
@Nullable Step	getRoot() Gets the root node for the step tree.
void	popContext() Pops the current context off of the stepper.
void	popStep() Stops a transformation step.
void	popTiming() Stops a non-content step.
void	pushContext(java.util.function.Supplier<java.lang.String> contentSupp) Pushes a new context to the Stepper.
Step	pushStep(java.lang.String name) Starts a step in the current context.
Step	pushStep(java.lang.String name, Step.StepContextType contextType) Starts a step in the current context.
Step	pushStepWithContent(java.lang.String name, Step.StepContextType contextType, java.util.function.Supplier<java.lang.String> preContent) Start a step in the current context, overriding the current context's content supplier.
Step	pushTiming(java.lang.String name) Starts a non-content step.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugStepper

public DebugStepper(DebugPrintOptions opts,
                    int stopAtStep)

Method Detail

getOpts

public DebugPrintOptions getOpts()

Description copied from interface: Stepper

Get the DebugPrintOptions for this stepper.

Specified by:

getOpts in interface Stepper

Returns:

The DebugPrintOptions.

pushContext

public void pushContext(java.util.function.Supplier<java.lang.String> contentSupp)

Description copied from interface: Stepper

Pushes a new context to the Stepper.

Specified by:

pushContext in interface Stepper

Parameters:

contentSupp - The supplier to evaluate the data on each step.

popContext

public void popContext()

Description copied from interface: Stepper

Pops the current context off of the stepper.

Specified by:

popContext in interface Stepper

pushStep

public Step pushStep(java.lang.String name)

Description copied from interface: Stepper

Starts a step in the current context.

Specified by:

pushStep in interface Stepper

Parameters:

name - A descriptive name for the step.

pushStep

public Step pushStep(java.lang.String name,
                     Step.StepContextType contextType)

Description copied from interface: Stepper

Starts a step in the current context.

Specified by:

pushStep in interface Stepper

Parameters:

name - A descriptive name for the step.

pushStepWithContent

public Step pushStepWithContent(java.lang.String name,
                                Step.StepContextType contextType,
                                java.util.function.Supplier<java.lang.String> preContent)

Description copied from interface: Stepper

Start a step in the current context, overriding the current context's content supplier.

Specified by:

pushStepWithContent in interface Stepper

Parameters:

name - A descriptive name for the step.

preContent - The content supplier for the step.

popStep

public void popStep()

Description copied from interface: Stepper

Stops a transformation step.

Specified by:

popStep in interface Stepper

pushTiming

public Step pushTiming(java.lang.String name)

Description copied from interface: Stepper

Starts a non-content step.

Specified by:

pushTiming in interface Stepper

Parameters:

name - The name.

popTiming

public void popTiming()

Description copied from interface: Stepper

Stops a non-content step.

Specified by:

popTiming in interface Stepper

except

public void except(java.lang.Throwable e)

Description copied from interface: Stepper

Marks the Stepper as having caught an exception.

Specified by:

except in interface Stepper

Parameters:

e - The throwable. Will be re-throw silently.

getRoot

@Nullable
public @Nullable Step getRoot()

Description copied from interface: Stepper

Gets the root node for the step tree.

Specified by:

getRoot in interface Stepper

Returns:

The root node, may return null if no steps were taken.