Interface InitialBranchState<STATE>

Type Parameters:
STATE - type of initial state to produce.
All Known Implementing Classes:
InitialBranchState.State

public interface InitialBranchState<STATE>
Factory for initial state of TraversalBranches in a traversal.
  • Field Details

  • Method Details

    • initialState

      STATE initialState(Path path)
      Returns an initial state for a Path. All paths entering this method are start paths(es) of a traversal. State is passed down along traversal branches as the traversal progresses and can be changed at any point by a PathExpander to becomes the new state from that point in that branch and downwards.
      Parameters:
      path - the start branch to return the initial state for.
      Returns:
      an initial state for the traversal branch.
    • reverse

      default InitialBranchState<STATE> reverse()
      Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.
      Returns:
      an instance which produces reversed initial state.