AbstractGrailsPlugin (Grace Framework

org.grails.plugins.AbstractGrailsPlugin

All Implemented Interfaces and Traits:

GrailsPlugin
```
public abstract class AbstractGrailsPlugin
extends GroovyObjectSupport
implements GrailsPlugin
```
Abstract implementation that provides some default behaviours
Authors:
Graeme Rocher

Field Summary

Fields
Modifiers	Name	Description
`static String`	`PLUGIN_GROOVY`
`static String`	`PLUGIN_GROOVY_PATH`
`static String`	`PLUGIN_YML`
`static String`	`PLUGIN_YML_PATH`
`protected ApplicationContext`	`applicationContext`
`protected Config`	`config`
`protected Map<String, Object>`	`dependencies`
`protected String[]`	`dependencyNames`
`protected String[]`	`evictionList`
`protected GrailsApplication`	`grailsApplication`
`protected boolean`	`isBase`
`protected GrailsPluginManager`	`manager`
`protected Class<?>`	`pluginClass`
`protected PropertySource<?>`	`propertySource`
`protected String`	`version`

Constructor Summary

Constructors
Constructor and description
`AbstractGrailsPlugin(Class<?> pluginClass, GrailsApplication application)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public boolean`	`checkForChanges()`
	`public int`	`compareTo(Object o)`
	`public boolean`	`equals(Object o)`
	`protected Resource`	`getConfigurationResource(Class<?> pluginClass, String path)`
	`public String[]`	`getDependencyNames()`
	`public String`	`getDependentVersion(String name)`
	`public String[]`	`getEvictionNames()`
	`public String`	`getFileSystemName()`
	`public String`	`getFileSystemShortName()`
	`public String[]`	`getLoadAfterNames()`
	`public String[]`	`getLoadBeforeNames()`
	`public GrailsPluginManager`	`getManager()`
	`public String`	`getName()`
	`public int`	`getOrder()`
	`public Class<?>`	`getPluginClass()`
	`public String`	`getPluginPath()`
	`public String`	`getPluginPathCamelCase()`
	`public PropertySource<?>`	`getPropertySource()`
	`public String`	`getVersion()`
	`public List<WatchPattern>`	`getWatchedResourcePatterns()`
	`public boolean`	`hasInterestInChange(String path)`
	`public int`	`hashCode()`
	`public boolean`	`isBasePlugin()`
	`public boolean`	`isEnabled(String[] profiles)`
	`protected Resource`	`readPluginConfiguration(Class<?> pluginClass)`
	`public void`	`refresh()`
	`public void`	`setApplication(GrailsApplication application)`
	`public void`	`setApplicationContext(ApplicationContext applicationContext)`
	`public void`	`setBasePlugin(boolean isBase)`
	`public void`	`setManager(GrailsPluginManager manager)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GroovyObjectSupport`	`equals, getClass, getMetaClass, getProperty, hashCode, invokeMethod, notify, notifyAll, setMetaClass, setProperty, toString, wait, wait, wait`

- Field Detail
  - public static final String PLUGIN_GROOVY
  - public static final String PLUGIN_GROOVY_PATH
  - public static final String PLUGIN_YML
  - public static final String PLUGIN_YML_PATH
  - protected ApplicationContext applicationContext
  - protected Config config
  - protected Map<String, Object> dependencies
  - protected String[] dependencyNames
  - protected String[] evictionList
  - protected GrailsApplication grailsApplication
  - protected boolean isBase
  - protected GrailsPluginManager manager
  - protected Class<?> pluginClass
  - protected PropertySource<?> propertySource
  - protected String version
- Constructor Detail
  - public AbstractGrailsPlugin(Class<?> pluginClass, GrailsApplication application)
- Method Detail
  - public boolean checkForChanges()
  - public int compareTo(Object o)
  - @Override
    public boolean equals(Object o)
  - protected Resource getConfigurationResource(Class<?> pluginClass, String path)
  - public String[] getDependencyNames()
  - public String getDependentVersion(String name)
  - public String[] getEvictionNames()
  - public String getFileSystemName()
  - public String getFileSystemShortName()
  - public String[] getLoadAfterNames()
  - public String[] getLoadBeforeNames()
  - public GrailsPluginManager getManager()
  - public String getName()
  - @Override
    public int getOrder()
  - public Class<?> getPluginClass()
  - public String getPluginPath()
  - public String getPluginPathCamelCase()
  - @Override
    public PropertySource<?> getPropertySource()
  - public String getVersion()
  - public List<WatchPattern> getWatchedResourcePatterns()
  - public boolean hasInterestInChange(String path)
  - @Override
    public int hashCode()
  - public boolean isBasePlugin()
  - @Override
    public boolean isEnabled(String[] profiles)
  - protected Resource readPluginConfiguration(Class<?> pluginClass)
  - public void refresh()
  - public void setApplication(GrailsApplication application)
  - public void setApplicationContext(ApplicationContext applicationContext)
  - public void setBasePlugin(boolean isBase)
  - public void setManager(GrailsPluginManager manager)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class AbstractGrailsPlugin

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String PLUGIN_GROOVY

public static final String PLUGIN_GROOVY_PATH

public static final String PLUGIN_YML

public static final String PLUGIN_YML_PATH

protected ApplicationContext applicationContext

protected Config config

protected Map<String, Object> dependencies

protected String[] dependencyNames

protected String[] evictionList

protected GrailsApplication grailsApplication

protected boolean isBase

protected GrailsPluginManager manager

protected Class<?> pluginClass

protected PropertySource<?> propertySource

protected String version

Constructor Detail

public AbstractGrailsPlugin(Class<?> pluginClass, GrailsApplication application)

Method Detail

public boolean checkForChanges()

public int compareTo(Object o)

@Overridepublic boolean equals(Object o)

protected Resource getConfigurationResource(Class<?> pluginClass, String path)

public String[] getDependencyNames()

public String getDependentVersion(String name)

public String[] getEvictionNames()

public String getFileSystemName()

public String getFileSystemShortName()

public String[] getLoadAfterNames()

public String[] getLoadBeforeNames()

public GrailsPluginManager getManager()

public String getName()

@Overridepublic int getOrder()

public Class<?> getPluginClass()

public String getPluginPath()

public String getPluginPathCamelCase()

@Overridepublic PropertySource<?> getPropertySource()

public String getVersion()

public List<WatchPattern> getWatchedResourcePatterns()

public boolean hasInterestInChange(String path)

@Overridepublic int hashCode()

public boolean isBasePlugin()

@Overridepublic boolean isEnabled(String[] profiles)

protected Resource readPluginConfiguration(Class<?> pluginClass)

public void refresh()

public void setApplication(GrailsApplication application)

public void setApplicationContext(ApplicationContext applicationContext)

public void setBasePlugin(boolean isBase)

public void setManager(GrailsPluginManager manager)

@Override
public boolean equals(Object o)

@Override
public int getOrder()

@Override
public PropertySource<?> getPropertySource()

@Override
public int hashCode()

@Override
public boolean isEnabled(String[] profiles)