io.hgc.jarspec

Interface Specification

public interface Specification

Represents a Specification consisting of statements about behaviour and automated tests for those statements. Primary interface for all specs written with JarSpec.

Method Summary

Modifier and Type	Method and Description
default java.util.stream.Stream<SpecificationNode>	byAllOf(SpecificationNode... specificationNodes) Convenience method providing a concise syntax for combining specifications into a list
default SpecificationNode	describe(String unit, ByMultiple specifications)
default SpecificationNode	describe(String unit, BySingle specification)
default SpecificationNode	describe(String unit, SpecificationNode... specificationNodes)
default SpecificationNode	it(String statement)
default SpecificationNode	it(String statement, Test test)
SpecificationNode	root()

Method Detail

root

SpecificationNode root()

describe

default SpecificationNode describe(String unit,
                                   SpecificationNode... specificationNodes)

describe

default SpecificationNode describe(String unit,
                                   BySingle specification)

Parameters:

unit - description of a unit of behaviour

specification - nested specification for the behaviour of the unit

Returns:

the overall specification

describe

default SpecificationNode describe(String unit,
                                   ByMultiple specifications)

Parameters:

unit - description of a unit of behaviour

specifications - nested specifications for the behaviour of the unit

Returns:

the overall specification

it

default SpecificationNode it(String statement,
                             Test test)

Parameters:

statement - a statement about the behaviour of a unit

test - an automated test for the statement

Returns:

a specification consisting of single automatically verifiable statement

it

default SpecificationNode it(String statement)

Parameters:

statement - a statement about the behaviour of a unit

Returns:

a specification consisting of single statement with no automated test

byAllOf

default java.util.stream.Stream<SpecificationNode> byAllOf(SpecificationNode... specificationNodes)

Convenience method providing a concise syntax for combining specifications into a list

Parameters:

specificationNodes - specifications to be combined

Returns:

a List containing all of the specifications in the order provided