CycleProtector

java.lang.Object

com.zfabrik.work.CycleProtector

public class CycleProtector extends Object

A generic cycle detection utility that can be used in methods that may run into recursive control flows.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

CycleProtector.CycleDetectedException

Exception thrown when a cycle was detected

static class

CycleProtector.PendingCycleProtectionException

Exception thrown when a protection stack was not cleanly resolved at the end of a work unit.
Constructor Summary

Constructors

Constructor

Description

CycleProtector()
Method Summary

Modifier and Type

Method

Description

static <T> T

call(String node, Callable<T> call)

Call a control flow as Callable

static void

clear()

Forcibly clear the protector.

static int

depth()

Returns depth of current traversal.

static void

enter(String node)

Enter a control flow that is not to be traversed again deeper.

static void

leave(String node)

Leave a control flow again.

static void

run(String node, Runnable run)

Run a control flow

protected static String

stateToString()

static <T> T

supply(String node, Supplier<T> supplier)

Call a control flow as Supplier

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- CycleProtector
  
  public CycleProtector()
Method Details
- enter
  
  public static void enter(String node) throws CycleProtector.CycleDetectedException
  
  Enter a control flow that is not to be traversed again deeper. This may be some dependency inspection, some graph traversal, anything where a cyclic repetition is to be avoided. The node string passed identifies the control flow.
  
  Throws:
  
  CycleProtector.CycleDetectedException
- clear
  
  public static void clear()
  
  Forcibly clear the protector. Use with caution, if at all
- leave
  
  public static void leave(String node) throws CycleProtector.CycleDetectedException
  
  Leave a control flow again. This must be the last entered.
  
  Throws:
  
  CycleProtector.CycleDetectedException
- run
  
  public static void run(String node, Runnable run)
  
  Run a control flow
- call
  
  public static <T> T call(String node, Callable<T> call) throws Exception
  
  Call a control flow as Callable
  
  Throws:
  
  Exception
- supply
  
  public static <T> T supply(String node, Supplier<T> supplier)
  
  Call a control flow as Supplier
- stateToString
  
  protected static String stateToString()
- depth
  
  public static int depth()
  
  Returns depth of current traversal.