org.bladerunnerjs.api

Class Workbench<N extends org.bladerunnerjs.model.engine.Node>

java.lang.Object

org.bladerunnerjs.model.engine.AbstractNode

org.bladerunnerjs.model.AbstractBRJSNode

org.bladerunnerjs.model.AbstractAssetContainer

org.bladerunnerjs.model.AbstractBundlableNode

org.bladerunnerjs.model.AbstractBrowsableNode

org.bladerunnerjs.api.Workbench<N>

All Implemented Interfaces:

BRJSNode, BrowsableNode, BundlableNode, TestableNode, org.bladerunnerjs.model.AssetContainer, org.bladerunnerjs.model.engine.Node

Direct Known Subclasses:

BladesetWorkbench, BladeWorkbench

public abstract class Workbench<N extends org.bladerunnerjs.model.engine.Node>
extends org.bladerunnerjs.model.AbstractBrowsableNode
implements TestableNode

Nested Class Summary

Nested classes/interfaces inherited from class org.bladerunnerjs.model.AbstractBundlableNode

org.bladerunnerjs.model.AbstractBundlableNode.Messages

Field Summary

Fields inherited from class org.bladerunnerjs.model.engine.AbstractNode

dir, rootNode

Constructor Summary

Constructors

Constructor and Description
Workbench(org.bladerunnerjs.model.engine.RootNode rootNode, org.bladerunnerjs.model.engine.Node parent, MemoizedFile dir)

Method Summary

Modifier and Type	Method and Description
void	addTemplateTransformations(java.util.Map<java.lang.String,java.lang.String> transformations) Template transformation are used to replace aliases for namings that are automatically replaced when creating an node.
java.lang.String	getTypeName()
boolean	isNamespaceEnforced()
MemoizedFile[]	memoizedScopeFiles()
N	parent()
java.lang.String	requirePrefix()
void	runTests(TestType... testTypes) The method runs the tests specified by the test type from within the current TestableNode.
DirNode	styleResources()
TypedTestPack	testType(java.lang.String typedTestPackName) The method retrieves the available TypedTestPack of specified type (unit, acceptance, integration or performance) from within the current TestableNode.
java.util.List<TypedTestPack>	testTypes() The method retrieves the available test types from within the current TestableNode.

Methods inherited from class org.bladerunnerjs.model.AbstractBrowsableNode

filterIndexPage

Methods inherited from class org.bladerunnerjs.model.AbstractBundlableNode

assets, getBundleSet, getLinkedAsset, handleLogicalRequest, handleLogicalRequest, seedAssets

Methods inherited from class org.bladerunnerjs.model.AbstractAssetContainer

app, asset, assetDiscoveryResult, assets, canonicaliseRequirePath

Methods inherited from class org.bladerunnerjs.model.AbstractBRJSNode

getTemplateName, populate, root

Methods inherited from class org.bladerunnerjs.model.engine.AbstractNode

addObserver, addObserver, containsFile, create, createDefaultNode, delete, dir, dirExists, discoverAllChildren, exists, file, getObservers, incrementChildFileVersions, incrementFileVersion, nodeProperties, notifyObservers, parentNode, ready, rootStorageDir, setNodeDir, storageDir, storageFile, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bladerunnerjs.api.BundlableNode

assets, getBundleSet, getLinkedAsset, handleLogicalRequest, handleLogicalRequest, seedAssets

Methods inherited from interface org.bladerunnerjs.model.AssetContainer

app, asset, assets, canonicaliseRequirePath, scopeAssetContainers

Methods inherited from interface org.bladerunnerjs.api.BRJSNode

getTemplateName, populate

Methods inherited from interface org.bladerunnerjs.model.engine.Node

addObserver, addObserver, containsFile, create, delete, dir, dirExists, discoverAllChildren, exists, file, getObservers, incrementChildFileVersions, incrementFileVersion, nodeProperties, notifyObservers, parentNode, ready, storageDir, storageFile

Constructor Detail

Workbench

public Workbench(org.bladerunnerjs.model.engine.RootNode rootNode,
                 org.bladerunnerjs.model.engine.Node parent,
                 MemoizedFile dir)

Method Detail

memoizedScopeFiles

public MemoizedFile[] memoizedScopeFiles()

Specified by:

memoizedScopeFiles in interface org.bladerunnerjs.model.engine.Node

Overrides:

memoizedScopeFiles in class org.bladerunnerjs.model.engine.AbstractNode

styleResources

public DirNode styleResources()

parent

public N parent()

addTemplateTransformations

public void addTemplateTransformations(java.util.Map<java.lang.String,java.lang.String> transformations)
                                throws ModelUpdateException

Description copied from interface: BRJSNode

Template transformation are used to replace aliases for namings that are automatically replaced when creating an node. They may be added to any template and must be prefix by `@` to indicate that the token will be replaced. The method applies these replacements to the BRJSNode.

Specified by:

addTemplateTransformations in interface BRJSNode

Parameters:

transformations - a Map of Strings to Strings where the key is the token and the value is the String it will be replaced with * @see Custom Templates

Throws:

ModelUpdateException - for any exceptions thrown while calculating node template transformations

requirePrefix

public java.lang.String requirePrefix()

Specified by:

requirePrefix in interface org.bladerunnerjs.model.AssetContainer

isNamespaceEnforced

public boolean isNamespaceEnforced()

Specified by:

isNamespaceEnforced in interface org.bladerunnerjs.model.AssetContainer

runTests

public void runTests(TestType... testTypes)

Description copied from interface: TestableNode

The method runs the tests specified by the test type from within the current TestableNode.

Specified by:

runTests in interface TestableNode

Parameters:

testTypes - may be at least one of the following: UT (unit tests), AT (acceptance tests), IT (integration tests) or PT (performance tests)

testTypes

public java.util.List<TypedTestPack> testTypes()

Description copied from interface: TestableNode

The method retrieves the available test types from within the current TestableNode.

Specified by:

testTypes in interface TestableNode

Returns:

a list of TypedTestPack showing the location and name of the tests available.

testType

public TypedTestPack testType(java.lang.String typedTestPackName)

Description copied from interface: TestableNode

The method retrieves the available TypedTestPack of specified type (unit, acceptance, integration or performance) from within the current TestableNode.

Specified by:

testType in interface TestableNode

Parameters:

typedTestPackName - may be one of the following: UT (unit tests), AT (acceptance tests), IT (integration tests) or PT (performance tests)

Returns:

a TypedTestPack object showing the location and name of the test pack available.

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface org.bladerunnerjs.model.engine.Node

Overrides:

getTypeName in class org.bladerunnerjs.model.engine.AbstractNode