org.bladerunnerjs.api

Interface BRJSNode

All Superinterfaces:

org.bladerunnerjs.model.engine.Node

All Known Subinterfaces:

org.bladerunnerjs.model.AssetContainer, BrowsableNode, BundlableNode, JsLib

All Known Implementing Classes:

org.bladerunnerjs.model.AbstractAssetContainer, org.bladerunnerjs.model.AbstractBRJSNode, org.bladerunnerjs.model.AbstractBRJSRootNode, org.bladerunnerjs.model.AbstractBrowsableNode, org.bladerunnerjs.model.AbstractBundlableNode, org.bladerunnerjs.model.AbstractComponent, App, Aspect, Blade, Bladeset, BladesetWorkbench, BladeWorkbench, BRJS, DirNode, org.bladerunnerjs.model.SourceResources, TestPack, Theme, TypedTestPack, Workbench

public interface BRJSNode
extends org.bladerunnerjs.model.engine.Node

A BRJSNode is a generic term for a folder under BRJS. Among others, BRJSNodes encompass AssetContainers, Apps, TemplateGroups or Themes.

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	getTemplateName() The method returns the name of the template, that is, the entity type and not the template group (which represents a collection of templates).
void	populate(java.lang.String templateGroup) Any BRJSNode may be populated according to a pre-existing template.
BRJS	root() The method returns a BRJS object that represents the root of the model.

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

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

Method Detail

root

BRJS root()

The method returns a BRJS object that represents the root of the model.

Specified by:

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

Returns:

a BRJS object that represents the root of the model.

populate

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

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.

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

TemplateInstallationException - if the template has not been found

ModelUpdateException - for other non-BRJS-specific issues

getTemplateName

java.lang.String getTemplateName()

The method returns the name of the template, that is, the entity type and not the template group (which represents a collection of templates).

Returns:

a String representing the name of the template

addTemplateTransformations

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

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.

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

ModelUpdateException - for non-BRJS-specific exceptions