org.bladerunnerjs.api.plugin

Interface RequirePlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractRequirePlugin

public interface RequirePlugin
extends Plugin

An interface that stands as the basis of all plugins that require an entity e.g. ServiceRequirePlugin, AliasDataRequirePlugin.

Method Summary

Modifier and Type	Method and Description
Asset	getAsset(BundlableNode bundlableNode, java.lang.String requirePathSuffix) The method returns the Asset retrieved using the selected requirePathSuffix from the bundable node.
java.lang.String	getPluginName() The method returns the name of the current plugin being used e.g.

Methods inherited from interface org.bladerunnerjs.api.plugin.Plugin

castTo, close, getPluginClass, instanceOf, setBRJS

Method Detail

getPluginName

java.lang.String getPluginName()

The method returns the name of the current plugin being used e.g. 'alias'.

Returns:

a String representing the name of the current plugin being used

getAsset

Asset getAsset(BundlableNode bundlableNode,
               java.lang.String requirePathSuffix)
        throws RequirePathException

The method returns the Asset retrieved using the selected requirePathSuffix from the bundable node.

Parameters:

bundlableNode - the BundlableNode which hosts the sought Asset

requirePathSuffix - the suffix of the Asset's require path, used as its unique identifier within the BundableNode

Returns:

an Asset retrieved using the selected requirePathSuffix from the bundable node

Throws:

RequirePathException - if the require path suffix may not be validated