io.hgc.jarspec

Class SpecificationNode

java.lang.Object

io.hgc.jarspec.SpecificationNode

public abstract class SpecificationNode
extends Object

Internal implementation of Specification as a tree structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpecificationNode.ResetSharedState

Method Summary

Modifier and Type	Method and Description
static SpecificationNode	error(String description, Throwable throwable) Factory method for error nodes in the tree representing a specification, indicating an exception thrown while building the specification tree itself.
static SpecificationNode	internal(String description, java.util.stream.Stream<SpecificationNode> children) Factory method for internal nodes in the tree representing a specification.
static SpecificationNode	leaf(String description) Factory method for leaf nodes in the tree representing a specification.
static SpecificationNode	leaf(String description, Test test) Factory method for leaf nodes in the tree representing a specification.
abstract SpecificationNode	only() Mark this node to be run exclusively (along with its children and any other nodes similarly marked)
SpecificationNode	skip() Mark this node to be skipped (along with its children and any other nodes similarly marked)
abstract SpecificationNode	withReset(SpecificationNode.ResetSharedState reset) Define a reset operation to clean up shared state between tests

Methods inherited from class java.lang.Object

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

Method Detail

skip

public SpecificationNode skip()

Mark this node to be skipped (along with its children and any other nodes similarly marked)

Returns:

a new node representing a skipped version of the original node

only

public abstract SpecificationNode only()

Mark this node to be run exclusively (along with its children and any other nodes similarly marked)

Returns:

a new node representing an exclusive version of the original node

withReset

public abstract SpecificationNode withReset(SpecificationNode.ResetSharedState reset)

Define a reset operation to clean up shared state between tests

Parameters:

reset - the reset operation

Returns:

a new version of this node that will reset state before each test

internal

public static SpecificationNode internal(String description,
                                         java.util.stream.Stream<SpecificationNode> children)

Factory method for internal nodes in the tree representing a specification. Consumers should generally use the default methods on Specification instead, unless creating their own behaviour mixin.

Parameters:

description - description for this node

children - stream of child nodes

Returns:

a newly-created node

leaf

public static SpecificationNode leaf(String description)

Factory method for leaf nodes in the tree representing a specification. Consumers should generally use the default methods on Specification instead, unless creating their own behaviour mixin.

Parameters:

description - description for this node

Returns:

a newly-created node

leaf

public static SpecificationNode leaf(String description,
                                     Test test)

Factory method for leaf nodes in the tree representing a specification. Consumers should generally use the default methods on Specification instead, unless creating their own behaviour mixin.

Parameters:

description - description for this node

test - optional automated test for this node

Returns:

a newly-created node

error

public static SpecificationNode error(String description,
                                      Throwable throwable)

Factory method for error nodes in the tree representing a specification, indicating an exception thrown while building the specification tree itself. Consumers should generally use the default methods on Specification instead, unless creating their own behaviour mixin.

Parameters:

description - description for this node

throwable - the original error

Returns:

a newly-created node