org.codehaus.groovy.grails.plugins
Class BasePluginFilter

java.lang.Object
  org.codehaus.groovy.grails.plugins.BasePluginFilter

All Implemented Interfaces:

PluginFilter

Direct Known Subclasses:

ExcludingPluginFilter, IncludingPluginFilter

public abstract class BasePluginFilter
extends java.lang.Object
implements PluginFilter

Base functionality shared by IncludingPluginFilter and ExcludingPluginFilter

Author:

Phil Zoio

Field Summary

protected java.util.Map

nameMap Holds a name to GrailsPlugin map (String, Plugin)

Constructor Summary

BasePluginFilter(java.util.Set suppliedNames)

BasePluginFilter(java.lang.String[] included)

Method Summary

protected abstract void	addPluginDependencies(java.util.List additionalList, GrailsPlugin plugin) Defines operation for adding dependencies for a plugin to the list
java.util.List	filterPluginList(java.util.List original) Template method shared by subclasses of BasePluginFilter.
protected java.util.Collection	getAllPlugins()
protected GrailsPlugin	getNamedPlugin(java.lang.String name)
protected abstract java.util.List	getPluginList(java.util.List original, java.util.List pluginList) Defines an operation getting the final list to return from the original and derived lists
protected java.util.Set	getSuppliedNames()
protected boolean	isDependentOn(GrailsPlugin plugin, java.lang.String pluginName) Checks whether a plugin is dependent on another plugin with the specified name
protected void	registerDependency(java.util.List additionalList, GrailsPlugin plugin) Adds a plugin to the additional if this hasn't happened already

Methods inherited from class java.lang.Object

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

Field Detail

nameMap

protected java.util.Map nameMap

Holds a name to GrailsPlugin map (String, Plugin)

Constructor Detail

BasePluginFilter

public BasePluginFilter(java.util.Set suppliedNames)

BasePluginFilter

public BasePluginFilter(java.lang.String[] included)

Method Detail

addPluginDependencies

protected abstract void addPluginDependencies(java.util.List additionalList,
                                              GrailsPlugin plugin)

Defines operation for adding dependencies for a plugin to the list

getPluginList

protected abstract java.util.List getPluginList(java.util.List original,
                                                java.util.List pluginList)

Defines an operation getting the final list to return from the original and derived lists

filterPluginList

public java.util.List filterPluginList(java.util.List original)

Template method shared by subclasses of BasePluginFilter.

Specified by:

filterPluginList in interface PluginFilter

Parameters:

original - the original supplied set of GrailsPlugin instances

Returns:

a sublist of these items

isDependentOn

protected boolean isDependentOn(GrailsPlugin plugin,
                                java.lang.String pluginName)

Checks whether a plugin is dependent on another plugin with the specified name

Parameters:

plugin - the plugin to compare

pluginName - the name to compare against

Returns:

true if plugin depends on pluginName

registerDependency

protected void registerDependency(java.util.List additionalList,
                                  GrailsPlugin plugin)

Adds a plugin to the additional if this hasn't happened already

getAllPlugins

protected java.util.Collection getAllPlugins()

getNamedPlugin

protected GrailsPlugin getNamedPlugin(java.lang.String name)

getSuppliedNames

protected java.util.Set getSuppliedNames()