org.bladerunnerjs.api.plugin

Interface AssetRegistry

All Known Implementing Classes:

DefaultAssetRegistry

public interface AssetRegistry

An interface for the management and recording of existing Assets.

Method Summary

Modifier and Type	Method and Description
java.util.List<Asset>	discoverFurtherAssets(MemoizedFile dir, java.lang.String requirePrefix, java.util.List<Asset> implicitDependencies) The method retrieves the List of Assets identified by the AssetPlugins available for the current AssetContainer, specified by a MemoizedFile.
Asset	getRegisteredAsset(java.lang.String requirePath) The method retrieves the registered Asset identified by the specified require path within the current registry.
java.util.Set<Asset>	getRegisteredAssets() Returns all Assets registered with the Asset registry
java.util.Set<LinkedAsset>	getRegisteredSeedAssets() Returns all Assets registered as seed assets with the Asset registry
boolean	hasRegisteredAsset(java.lang.String requirePath) The method verifies whether the specified require path is the valid require path for one of its registered assets.
boolean	hasSeedAsset(java.lang.String requirePath) The method verifies whether the specified require path is the valid require path for one of its seed assets.
void	promoteRegisteredAssetToSeed(LinkedAsset asset) The method adds an already registered LinkedAsset to the list of seed assets.
void	registerAsset(Asset asset) The method registers the specified LinkedAsset by adding it to the assets for the current directory, provided it has not been registered beforehand.
void	registerSeedAsset(LinkedAsset asset) The method adds the specified LinkedAsset to the existing list of seed assets.

Method Detail

registerSeedAsset

void registerSeedAsset(LinkedAsset asset)

The method adds the specified LinkedAsset to the existing list of seed assets.

Parameters:

asset - a LinkedAsset object that will be added to the existing list of seed assets

promoteRegisteredAssetToSeed

void promoteRegisteredAssetToSeed(LinkedAsset asset)

The method adds an already registered LinkedAsset to the list of seed assets.

Parameters:

asset - an already registered LinkedAsset object that will be added to the list of seed assets

registerAsset

void registerAsset(Asset asset)

The method registers the specified LinkedAsset by adding it to the assets for the current directory, provided it has not been registered beforehand.

Parameters:

asset - a LinkedAsset object that will be registered by adding it to the assets for the current directory

hasSeedAsset

boolean hasSeedAsset(java.lang.String requirePath)

The method verifies whether the specified require path is the valid require path for one of its seed assets.

Parameters:

requirePath - a String object that will be verified to establish whether it denotes an Asset part of the seed assets for the registry.

Returns:

boolean returns a value of 'true' if the requirePath denotes an Asset part of the seed assets for the registry and 'false' otherwise.

hasRegisteredAsset

boolean hasRegisteredAsset(java.lang.String requirePath)

The method verifies whether the specified require path is the valid require path for one of its registered assets.

Parameters:

requirePath - a String object that will be verified to establish whether it denotes an Asset part of the registered assets for the registry.

Returns:

boolean returns a value of 'true' if the requirePath denotes an Asset part of the registered assets for the registry and 'false' otherwise.

getRegisteredAsset

Asset getRegisteredAsset(java.lang.String requirePath)

The method retrieves the registered Asset identified by the specified require path within the current registry.

Parameters:

requirePath - a String object that will determine which Asset will be retrieved

Returns:

the Asset object identified by the specified require path within the current registry.

getRegisteredAssets

java.util.Set<Asset> getRegisteredAssets()

Returns all Assets registered with the Asset registry

Returns:

assets

getRegisteredSeedAssets

java.util.Set<LinkedAsset> getRegisteredSeedAssets()

Returns all Assets registered as seed assets with the Asset registry

Returns:

assets

discoverFurtherAssets

java.util.List<Asset> discoverFurtherAssets(MemoizedFile dir,
                                            java.lang.String requirePrefix,
                                            java.util.List<Asset> implicitDependencies)

The method retrieves the List of Assets identified by the AssetPlugins available for the current AssetContainer, specified by a MemoizedFile.

Parameters:

dir - a MemoizedFile object specifying the assetContainer for which the AssetPlugins will be determined

requirePrefix - a String object specifying what require prefix the newly discovered Assets should adhere to

implicitDependencies - a List of Assets specifying the already determined implicit dependencies for the container

Returns:

the list of Assets identified by the AssetPlugins available for the current AssetContainer}