org.bladerunnerjs.api

Class App

java.lang.Object

org.bladerunnerjs.model.engine.AbstractNode

org.bladerunnerjs.model.AbstractBRJSNode

org.bladerunnerjs.api.App

All Implemented Interfaces:

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

public class App
extends org.bladerunnerjs.model.AbstractBRJSNode
implements org.bladerunnerjs.model.engine.NamedNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	App.Messages

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTAINER_NAME

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
App(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.
AppConf	appConf()
org.bladerunnerjs.model.AppJsLib	appJsLib(java.lang.String jsLibName)
java.util.List<org.bladerunnerjs.model.AppJsLib>	appJsLibs()
Aspect	aspect(java.lang.String aspectName) Get a named aspects.
java.util.List<Aspect>	aspects() Get the list of aspects for the App
void	assertValidName()
Bladeset	bladeset(java.lang.String bladesetName) Get a named bladeset.
java.util.List<Bladeset>	bladesets() Get the list of bladesets for the App
void	build(MemoizedFile targetDir)
void	buildWar(MemoizedFile targetFile)
Aspect	defaultAspect() Get the default aspect for the app.
Bladeset	defaultBladeset() Get the default bladeset for the app.
void	deploy()
java.util.List<org.bladerunnerjs.model.AssetContainer>	getAllAssetContainers() Returns *all* of the asset containers in the model.
java.lang.String	getName()
java.util.List<org.bladerunnerjs.model.AssetContainer>	getNonAspectAssetContainers()
java.lang.String	getRequirePrefix()
boolean	isMultiLocaleApp()
boolean	isValidName()
JsLib	jsLib(java.lang.String jsLibName)
java.util.List<JsLib>	jsLibs()
MemoizedFile	libsDir()
MemoizedFile[]	memoizedScopeFiles()
BRJS	parent()
void	populate(java.lang.String templateGroup) Any BRJSNode may be populated according to a pre-existing template.
void	populate(java.lang.String requirePrefix, java.lang.String templateGroup)
org.bladerunnerjs.utility.AppRequestHandler	requestHandler()

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

Field Detail

DEFAULT_CONTAINER_NAME

public static final java.lang.String DEFAULT_CONTAINER_NAME

See Also:

Constant Field Values

Constructor Detail

App

public App(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

getAllAssetContainers

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

Returns *all* of the asset containers in the model. This is different to BundleableNode.getAssetContainers which returns only the valid AssetContainers for a given BundleableNode.

Returns:

The list of AssetContainers

getNonAspectAssetContainers

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

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

parent

public BRJS parent()

isMultiLocaleApp

public boolean isMultiLocaleApp()

appConf

public AppConf appConf()
                throws ConfigException

Throws:

ConfigException

bladesets

public java.util.List<Bladeset> bladesets()

Get the list of bladesets for the App

Returns:

list of bladesets

bladeset

public Bladeset bladeset(java.lang.String bladesetName)

Get a named bladeset. bladeset("default") returns a bladeset with the name 'default' rather than the bladeset that represents the optional bladeset.

Parameters:

bladesetName - The name of the bladeset

Returns:

the named bladeset

defaultBladeset

public Bladeset defaultBladeset()

Get the default bladeset for the app. This is different from using bladeset("default").

Returns:

the default bladeset

See Also:

bladeset(java.lang.String)

aspects

public java.util.List<Aspect> aspects()

Get the list of aspects for the App

Returns:

list of aspects

aspect

public Aspect aspect(java.lang.String aspectName)

Get a named aspects. aspect("default") returns an aspect with the name 'default' rather than the aspect that represents the optional aspect.

Parameters:

aspectName - The name of the Aspect

Returns:

the named bladeset

defaultAspect

public Aspect defaultAspect()

Get the default aspect for the app. This is different from using aspect("default").

Returns:

the default aspect

See Also:

defaultAspect()

jsLibs

public java.util.List<JsLib> jsLibs()

jsLib

public JsLib jsLib(java.lang.String jsLibName)

appJsLibs

public java.util.List<org.bladerunnerjs.model.AppJsLib> appJsLibs()

appJsLib

public org.bladerunnerjs.model.AppJsLib appJsLib(java.lang.String jsLibName)

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

populate

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

Throws:

javax.naming.InvalidNameException

ModelUpdateException

TemplateInstallationException

deploy

public void deploy()
            throws TemplateInstallationException

Throws:

TemplateInstallationException

getRequirePrefix

public java.lang.String getRequirePrefix()

libsDir

public MemoizedFile libsDir()

requestHandler

public org.bladerunnerjs.utility.AppRequestHandler requestHandler()

build

public void build(MemoizedFile targetDir)
           throws ModelOperationException

Throws:

ModelOperationException

buildWar

public void buildWar(MemoizedFile targetFile)
              throws ModelOperationException

Throws:

ModelOperationException