org.codehaus.groovy.grails.plugins

Class MockGrailsPluginManager

java.lang.Object

org.codehaus.groovy.grails.plugins.AbstractGrailsPluginManager

org.codehaus.groovy.grails.plugins.MockGrailsPluginManager

All Implemented Interfaces:

GrailsPluginManager

public class MockGrailsPluginManager
extends AbstractGrailsPluginManager

Since:

0.4

Author:

Graeme Rocher

Field Summary

Fields inherited from class org.codehaus.groovy.grails.plugins.AbstractGrailsPluginManager

CONFIG_FILE

Fields inherited from interface org.codehaus.groovy.grails.plugins.GrailsPluginManager

BEAN_NAME

Constructor Summary

Constructors

Constructor and Description
MockGrailsPluginManager()
MockGrailsPluginManager(GrailsApplication application)

Method Summary

Modifier and Type	Method and Description
void	checkForChanges() Checks all the plugins to see whether they have any changes
void	doWebDescriptor(Resource descriptor, java.io.Writer target) Takes the specified web descriptor reference and configures it with all the plugins outputting the result to the target Writer instance
void	expectCheckForChanges()
BuildSettings	getBuildSettings()
GrailsPlugin	getGrailsPlugin(java.lang.String name) Retrieves a name Grails plugin instance
GrailsPlugin	getGrailsPlugin(java.lang.String name, java.math.BigDecimal version)
PluginBuildSettings	getPluginBuildSettings()
java.util.Collection<?>	getPluginObservers(GrailsPlugin plugin) Retrieves a collection of plugins that are observing the specified plugin
ServletContext	getServletContext()
GrailsPlugin[]	getUserPlugins() Gets plugin installed by the user and not provided by the framework
boolean	hasGrailsPlugin(java.lang.String name)
void	informObservers(java.lang.String pluginName, java.util.Map event) inform the specified plugins observers of the event specified by the passed Map instance
boolean	isInitialised()
void	loadPlugins() Performs the initial load of plug-ins throwing an exception if any dependencies don't resolve
void	refreshPlugin(java.lang.String name) Refreshes the specified plugin.
void	registerMockPlugin(GrailsPlugin plugin)
void	setServletContext(ServletContext servletContext)
void	verify()

Methods inherited from class org.codehaus.groovy.grails.plugins.AbstractGrailsPluginManager

doArtefactConfiguration, doDynamicMethods, doPostProcessing, doRuntimeConfiguration, doRuntimeConfiguration, getAllPlugins, getFailedLoadPlugins, getFailedPlugin, getGrailsPlugin, getGrailsPluginForClassName, getPluginForClass, getPluginForInstance, getPluginPath, getPluginPathForClass, getPluginPathForInstance, getPluginResources, getPluginViewsPathForClass, getPluginViewsPathForInstance, getTypeFilters, informOfClassChange, informOfClassChange, informOfFileChange, informPluginsOfConfigChange, registerProvidedArtefacts, setApplication, setApplicationContext, setLoadCorePlugins, shutdown, supportsCurrentBuildScope

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockGrailsPluginManager

public MockGrailsPluginManager(GrailsApplication application)

MockGrailsPluginManager

public MockGrailsPluginManager()

Method Detail

getServletContext

public ServletContext getServletContext()

getGrailsPlugin

public GrailsPlugin getGrailsPlugin(java.lang.String name)

Description copied from interface: GrailsPluginManager

Retrieves a name Grails plugin instance

Specified by:

getGrailsPlugin in interface GrailsPluginManager

Overrides:

getGrailsPlugin in class AbstractGrailsPluginManager

Parameters:

name - The name of the plugin

Returns:

The GrailsPlugin instance or null if it doesn't exist

getGrailsPlugin

public GrailsPlugin getGrailsPlugin(java.lang.String name,
                                    java.math.BigDecimal version)

hasGrailsPlugin

public boolean hasGrailsPlugin(java.lang.String name)

Specified by:

hasGrailsPlugin in interface GrailsPluginManager

Overrides:

hasGrailsPlugin in class AbstractGrailsPluginManager

Parameters:

name - The name of the plugin

Returns:

True if the the manager has a loaded plugin with the given name

registerMockPlugin

public void registerMockPlugin(GrailsPlugin plugin)

getUserPlugins

public GrailsPlugin[] getUserPlugins()

Description copied from interface: GrailsPluginManager

Gets plugin installed by the user and not provided by the framework

Returns:

A list of user plugins

loadPlugins

public void loadPlugins()
                 throws PluginException

Description copied from interface: GrailsPluginManager

Performs the initial load of plug-ins throwing an exception if any dependencies don't resolve

Throws:

PluginException - Thrown when an error occurs loading the plugins

checkForChanges

public void checkForChanges()

Description copied from interface: GrailsPluginManager

Checks all the plugins to see whether they have any changes

doWebDescriptor

public void doWebDescriptor(Resource descriptor,
                            java.io.Writer target)

Description copied from interface: GrailsPluginManager

Takes the specified web descriptor reference and configures it with all the plugins outputting the result to the target Writer instance

Parameters:

descriptor - The Resource of the descriptor

target - The Writer to write the result to

isInitialised

public boolean isInitialised()

Specified by:

isInitialised in interface GrailsPluginManager

Overrides:

isInitialised in class AbstractGrailsPluginManager

Returns:

the initialised

refreshPlugin

public void refreshPlugin(java.lang.String name)

Description copied from interface: GrailsPluginManager

Refreshes the specified plugin. A refresh will force to plugin to "touch" each of its watched resources and fire modified events for each

Parameters:

name - The name of the plugin to refresh

getPluginObservers

public java.util.Collection<?> getPluginObservers(GrailsPlugin plugin)

Description copied from interface: GrailsPluginManager

Retrieves a collection of plugins that are observing the specified plugin

Parameters:

plugin - The plugin to retrieve observers for

Returns:

A collection of observers

informObservers

public void informObservers(java.lang.String pluginName,
                            java.util.Map event)

Description copied from interface: GrailsPluginManager

inform the specified plugins observers of the event specified by the passed Map instance

Parameters:

pluginName - The name of the plugin

event - The event

setServletContext

public void setServletContext(ServletContext servletContext)

expectCheckForChanges

public void expectCheckForChanges()

verify

public void verify()

getBuildSettings

public BuildSettings getBuildSettings()

getPluginBuildSettings

public PluginBuildSettings getPluginBuildSettings()