org.bladerunnerjs.api

Class Blade

java.lang.Object

org.bladerunnerjs.model.engine.AbstractNode

org.bladerunnerjs.model.AbstractBRJSNode

org.bladerunnerjs.model.AbstractAssetContainer

org.bladerunnerjs.model.AbstractComponent

org.bladerunnerjs.api.Blade

All Implemented Interfaces:

BRJSNode, TestableNode, org.bladerunnerjs.model.AssetContainer, org.bladerunnerjs.model.engine.NamedNode, org.bladerunnerjs.model.engine.Node

public final class Blade
extends org.bladerunnerjs.model.AbstractComponent
implements org.bladerunnerjs.model.engine.NamedNode

Nested Class Summary

Nested classes/interfaces inherited from class org.bladerunnerjs.model.engine.AbstractNode

org.bladerunnerjs.model.engine.AbstractNode.Messages

Field Summary

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

dir, rootNode

Fields inherited from interface org.bladerunnerjs.model.engine.NamedNode

UNDEFINED_NODE_NAME

Constructor Summary

Constructors

Constructor and Description
Blade(org.bladerunnerjs.model.engine.RootNode rootNode, org.bladerunnerjs.model.engine.Node parent, MemoizedFile dir, java.lang.String name)

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.
void	assertValidName()
java.lang.String	getName()
boolean	isNamespaceEnforced()
boolean	isValidName()
MemoizedFile[]	memoizedScopeFiles()
Bladeset	parent()
void	populate(java.lang.String templateGroup) Any BRJSNode may be populated according to a pre-existing template.
java.lang.String	requirePrefix()
java.util.List<org.bladerunnerjs.model.AssetContainer>	scopeAssetContainers()
BladeWorkbench	workbench()

Methods inherited from class org.bladerunnerjs.model.AbstractComponent

runTests, testType, testTypes

Methods inherited from class org.bladerunnerjs.model.AbstractAssetContainer

app, asset, assetDiscoveryResult, assets, canonicaliseRequirePath

Methods inherited from class org.bladerunnerjs.model.AbstractBRJSNode

getTemplateName, root

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

addObserver, addObserver, containsFile, create, createDefaultNode, delete, dir, dirExists, discoverAllChildren, exists, file, getObservers, getTypeName, 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.model.engine.Node

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

Methods inherited from interface org.bladerunnerjs.api.BRJSNode

getTemplateName, root

Constructor Detail

Blade

public Blade(org.bladerunnerjs.model.engine.RootNode rootNode,
             org.bladerunnerjs.model.engine.Node parent,
             MemoizedFile dir,
             java.lang.String name)

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

scopeAssetContainers

public java.util.List<org.bladerunnerjs.model.AssetContainer> scopeAssetContainers()

Specified by:

scopeAssetContainers in interface org.bladerunnerjs.model.AssetContainer

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

getName

public java.lang.String getName()

Specified by:

getName in interface org.bladerunnerjs.model.engine.NamedNode

isValidName

public boolean isValidName()

Specified by:

isValidName in interface org.bladerunnerjs.model.engine.NamedNode

assertValidName

public void assertValidName()
                     throws javax.naming.InvalidNameException

Specified by:

assertValidName in interface org.bladerunnerjs.model.engine.NamedNode

Throws:

javax.naming.InvalidNameException

populate

public void populate(java.lang.String templateGroup)
              throws javax.naming.InvalidNameException,
                     ModelUpdateException,
                     TemplateInstallationException

Description copied from interface: BRJSNode

Any BRJSNode may be populated according to a pre-existing template. The method will create the files and folders existing in the specified template, including their content, within the BRJSNode. This method is to help with consistency among your entities and may be used, for example, to adhere to certain programming or modular styles.

Specified by:

populate in interface BRJSNode

Overrides:

populate in class org.bladerunnerjs.model.AbstractBRJSNode

Parameters:

templateGroup - a String that represents the name by which the templates therein will be referenced when creating new nodes. The templateGroup may contain templates for various BRJS entities, and the one corresponding to your current BRJSNode type will be retrieved automatically.

Throws:

javax.naming.InvalidNameException - if the node may not be created due to an invalid name associated to it

ModelUpdateException - for other non-BRJS-specific issues

TemplateInstallationException - if the template has not been found

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

parent

public Bladeset parent()

workbench

public BladeWorkbench workbench()