org.bladerunnerjs.api

Interface JsLib

All Superinterfaces:

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

public interface JsLib
extends org.bladerunnerjs.model.AssetContainer, org.bladerunnerjs.model.engine.NamedNode, TestableNode

JavaScript libraries to be used within your BRJS applications.

Field Summary

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

UNDEFINED_NODE_NAME

Method Summary

Modifier and Type	Method and Description
void	populate(java.lang.String libNamespace, java.lang.String templateGroup) The method will create the files and folders existing in the specified template, including their content, within the JsLib.

Methods inherited from interface org.bladerunnerjs.model.AssetContainer

app, asset, assets, canonicaliseRequirePath, isNamespaceEnforced, requirePrefix, scopeAssetContainers

Methods inherited from interface org.bladerunnerjs.api.BRJSNode

addTemplateTransformations, getTemplateName, populate, root

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

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

assertValidName, getName, isValidName

Methods inherited from interface org.bladerunnerjs.api.TestableNode

runTests, testType, testTypes

Method Detail

populate

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

The method will create the files and folders existing in the specified template, including their content, within the JsLib. 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:

libNamespace - the chosen namespace for the library

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 entity 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