org.bladerunnerjs.api.plugin

Interface CompositeContentPlugin

All Superinterfaces:

ContentPlugin, Plugin, RoutableContentPlugin

public interface CompositeContentPlugin
extends RoutableContentPlugin

Some content plug-ins are part of composites that may be used to wrap their content within a larger bundle. The CompositeContentPlugin interface should be used by all content plug-ins that are part of a larger composite plug-in, where the output of these plug-ins will not appear within the final bundle created during the build step.

The following methods are identifier-methods, and may be invoked before Plugin.setBRJS() has been invoked:

• getCompositeGroupName()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCompositeGroupName() Returns the group name of content plug-in, which allow composite content plug-ins that compose a number of related plug-ins.

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

getContentPathParser

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

getRequestPrefix, getUsedContentPaths, getValidContentPaths, handleRequest

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

castTo, close, getPluginClass, instanceOf, setBRJS

Method Detail

getCompositeGroupName

java.lang.String getCompositeGroupName()

Returns the group name of content plug-in, which allow composite content plug-ins that compose a number of related plug-ins.

Note: Developers should not rely on any class initialization performed within Plugin.setBRJS() as this method is an identifier-method which may be invoked before Plugin.setBRJS() has itself been invoked.

Returns:

the group name if one exists, or null otherwise.