Class STBuilder

java.lang.Object

io.nosqlbench.nb.spectest.core.STBuilder

All Implemented Interfaces:

STBuilderFacets.All, STBuilderFacets.Done, STBuilderFacets.WantsDebuggingOptions, STBuilderFacets.WantsPaths, STBuilderFacets.WantsPathsOrScannersOrValidators, STBuilderFacets.WantsScannersOrValidators, STBuilderFacets.WantsValidatorsOrDone

public abstract class STBuilder
extends Object
implements STBuilderFacets.All

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	debug
protected List<Path>	paths
protected List<STPathLoader>	scanners
protected List<STAssemblyValidator>	validators

Constructor Summary

Constructors

Constructor	Description
STBuilder()

Method Summary

Modifier and Type	Method	Description
STBuilderFacets.Done	debug()
STBuilderFacets.WantsValidatorsOrDone	matchNodes(Object... predicates)	Attach a Node scanner to this spec test builder by describing the sequence of nodes which are valid, with no extra node types allowed between the specified elements.
STBuilderFacets.WantsPathsOrScannersOrValidators	paths(Path... paths)	Provide additional path or paths, which can be either a readable file or a directory containing readable files or other directories.
STBuilderFacets.WantsValidatorsOrDone	scanners(STPathLoader... scanners)	Attach a set of scanners against Node sequences
STBuilderFacets.WantsValidatorsOrDone	scanners(STNodePredicate predicate)
STBuilderFacets.WantsDebuggingOptions	validators(STAssemblyValidator... validators)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nosqlbench.nb.spectest.api.STBuilderFacets.Done

build

Methods inherited from interface io.nosqlbench.nb.spectest.api.STBuilderFacets.WantsPaths

path, path, paths

Field Details

paths

protected List<Path> paths

scanners

protected List<STPathLoader> scanners

validators

protected List<STAssemblyValidator> validators

debug

protected boolean debug

Constructor Details

STBuilder

public STBuilder()

Method Details

paths

public STBuilderFacets.WantsPathsOrScannersOrValidators paths(Path... paths)

Description copied from interface: STBuilderFacets.WantsPaths

Provide additional path or paths, which can be either a readable file or a directory containing readable files or other directories. Only files which match a markdown path with a '.md' extension will be validated.

Specified by:

paths in interface STBuilderFacets.WantsPaths

Parameters:

paths - Paths to test

Returns:

this STBuilder for method chaining

scanners

public STBuilderFacets.WantsValidatorsOrDone scanners(STPathLoader... scanners)

Description copied from interface: STBuilderFacets.WantsScannersOrValidators

Attach a set of scanners against Node sequences

Specified by:

scanners in interface STBuilderFacets.WantsScannersOrValidators

Parameters:

scanners -

Returns:

scanners

public STBuilderFacets.WantsValidatorsOrDone scanners(STNodePredicate predicate)

Specified by:

scanners in interface STBuilderFacets.WantsScannersOrValidators

matchNodes

public STBuilderFacets.WantsValidatorsOrDone matchNodes(Object... predicates)

Description copied from interface: STBuilderFacets.WantsScannersOrValidators

Attach a Node scanner to this spec test builder by describing the sequence of nodes which are valid, with no extra node types allowed between the specified elements. This is a direct sequence matcher that is checked at each position in the parsed element stream. When a sequence is found, the search is resumed on the next element not included in the result.

The predicates can be one of the types supported by STNodePredicate and STNodePredicates. These can be wrapped in structural predicate form by using the helpers from STPredicateVerbs, particularly with an import like

import static io.nosqlbench.nb.spectest.traversal.STPredicateVerbs.*;

Specified by:

matchNodes in interface STBuilderFacets.WantsScannersOrValidators

Parameters:

predicates - The pattern to match

Returns:

this SpecTestBuilder for builder method chaining

validators

public STBuilderFacets.WantsDebuggingOptions validators(STAssemblyValidator... validators)

Specified by:

validators in interface STBuilderFacets.WantsValidatorsOrDone

debug

public STBuilderFacets.Done debug()

Specified by:

debug in interface STBuilderFacets.WantsDebuggingOptions