io.ataraxic.nomicflux.voyageur.fold

Class FoldContinue<N>

Object

FoldContinue<N>

Type Parameters:

N - Value provided in the NextNode case

All Implemented Interfaces:

CoProduct3<Unit,Unit,N,FoldContinue<N>>

public abstract class FoldContinue<N>
extends Object
implements CoProduct3<Unit,Unit,N,FoldContinue<N>>

Provide the next node in a fold, decompose a graph arbitrarily, or end the fold Isomorphic to Choice3<Unit, Unit, N>

Constructor Summary

Constructors

Constructor and Description
FoldContinue()

Method Summary

Modifier and Type	Method and Description
static <N> FoldContinue<N>	decompose()
static <N> FoldContinue<N>	endFold()
abstract <R> R	match(Fn1<? super Unit,? extends R> terminateFn, Fn1<? super Unit,? extends R> decomposeFn, Fn1<? super N,? extends R> nextNodeFn)
static <N> FoldContinue<N>	nextNode(N node) Provide the next node in a fold.
static <N> FoldContinue<N>	nodeOrDecompose(Maybe<N> node) Provide the next node if available, otherwise decompose the graph arbitrarily.
static <N> FoldContinue<N>	nodeOrTerminate(Maybe<N> node) Provide the next node if available, otherwise terminate the fold.

Methods inherited from class Object

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

Methods inherited from interface CoProduct3

converge, diverge, embed, project, projectA, projectB, projectC

Constructor Detail

FoldContinue

public FoldContinue()

Method Detail

nextNode

public static <N> FoldContinue<N> nextNode(N node)

Provide the next node in a fold.

Type Parameters:

N - The type of the node

Parameters:

node - The node to provide

Returns:

A FoldContinue with node

nodeOrTerminate

public static <N> FoldContinue<N> nodeOrTerminate(Maybe<N> node)

Provide the next node if available, otherwise terminate the fold.

Type Parameters:

N - The type of the node

Parameters:

node - A Maybe node to provide, if available

Returns:

Either a node N, or a signal to terminate the fold

nodeOrDecompose

public static <N> FoldContinue<N> nodeOrDecompose(Maybe<N> node)

Provide the next node if available, otherwise decompose the graph arbitrarily.

Type Parameters:

N - The type of the node

Parameters:

node - A Maybe node to provide, if available

Returns:

Either a node N, or a signal to decompose the graph without a node

decompose

public static <N> FoldContinue<N> decompose()

Type Parameters:

N - The type of a node that would have been provided

Returns:

A signal to decompose the graph without a node

endFold

public static <N> FoldContinue<N> endFold()

Type Parameters:

N - The type of a node that would have been provided

Returns:

A signal to end the fold

match

public abstract <R> R match(Fn1<? super Unit,? extends R> terminateFn,
                            Fn1<? super Unit,? extends R> decomposeFn,
                            Fn1<? super N,? extends R> nextNodeFn)

Specified by:

match in interface CoProduct3<Unit,Unit,N,FoldContinue<N>>