DefaultGrailsPlugin (Grails 5.1.8-SNAPSHOT)

org.grails.plugins.DefaultGrailsPlugin

All Implemented Interfaces and Traits:

ParentApplicationContextAware
```
@java.lang.SuppressWarnings("rawtypes")
public class DefaultGrailsPlugin
extends AbstractGrailsPlugin
implements ParentApplicationContextAware
```
Implementation of the GrailsPlugin interface that wraps a Groovy plugin class and provides the magic to invoke its various methods from Java.
Authors:
Graeme Rocher
Since:
0.4

Field Summary

Fields
Modifiers	Name	Description
`protected static org.apache.commons.logging.Log`	`LOG`
`protected org.springframework.beans.BeanWrapper`	`pluginBean`

Inherited fields
Fields inherited from class	Fields
`class AbstractGrailsPlugin`	`PLUGIN_GROOVY, PLUGIN_GROOVY_PATH, PLUGIN_YML, PLUGIN_YML_PATH, applicationContext, config, dependencies, dependencyNames, evictionList, grailsApplication, isBase, manager, pluginClass, propertySource, version`

Constructor Summary

Constructors
Constructor and description
`DefaultGrailsPlugin (java.lang.Class<?> pluginClass, org.springframework.core.io.Resource resource, GrailsApplication application)`
`DefaultGrailsPlugin (java.lang.Class<?> pluginClass, GrailsApplication application)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addExclude(Environment env)`
	`public BeanBuilder`	`beans(groovy.lang.Closure closure)`
	`public java.lang.Object`	`call(java.lang.Object arguments)`
	`public void`	`doArtefactConfiguration()`
	`public void`	`doWithApplicationContext(org.springframework.context.ApplicationContext ctx)`
	`public void`	`doWithDynamicMethods(org.springframework.context.ApplicationContext ctx)`
	`public void`	`doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)`
	`public void`	`doc(java.lang.String text)` deprecated: Dynamic document generation no longer supported
	`public java.lang.String[]`	`getDependencyNames()`
	`public java.lang.String`	`getDependentVersion(java.lang.String name)`
	`public Resource`	`getDescriptor()`
	`public java.lang.String`	`getFullName()`
	`public groovy.lang.GroovyObject`	`getInstance()`
	`public java.lang.String[]`	`getLoadAfterNames()`
	`public java.lang.String[]`	`getLoadBeforeNames()`
	`public org.apache.commons.logging.Log`	`getLog()`
	`public java.lang.String`	`getName()`
	`public java.lang.String[]`	`getObservedPluginNames()`
	`public org.springframework.context.ApplicationContext`	`getParentCtx()`
	`public GrailsPlugin`	`getPlugin()`
	`public Resource`	`getPluginDir()`
	`public java.util.List<java.lang.String>`	`getPluginExcludes()`
	`public java.util.Map`	`getProperties()`
	`public java.lang.Class<?>[]`	`getProvidedArtefacts()`
	`public org.springframework.core.io.support.PathMatchingResourcePatternResolver`	`getResolver()` Returns: the resolver
	`public java.util.Collection<? extends org.springframework.core.type.filter.TypeFilter>`	`getTypeFilters()`
	`public java.util.List<WatchPattern>`	`getWatchedResourcePatterns()`
	`public org.springframework.core.io.Resource[]`	`getWatchedResources()` Returns: the watchedResources
	`public boolean`	`hasInterestInChange(java.lang.String path)`
	`public boolean`	`isEnabled(java.lang.String[] activeProfiles)`
	`public boolean`	`isEnabled()`
	`public void`	`notifyOfEvent(java.util.Map event)`
	`public java.util.Map`	`notifyOfEvent(int eventKind, java.lang.Object source)`
	`public void`	`refresh()`
	`public void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
	`public void`	`setDescriptor(org.springframework.core.io.Resource descriptor)`
	`public void`	`setManager(GrailsPluginManager manager)`
	`public void`	`setParentApplicationContext(org.springframework.context.ApplicationContext parent)`
	`public void`	`setWatchedResources(org.springframework.core.io.Resource[] watchedResources)`
	`public boolean`	`supportsCurrentScopeAndEnvironment()`
	`public boolean`	`supportsEnvironment(Environment environment)`
	`public java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractGrailsPlugin`	`checkForChanges, compareTo, equals, getConfigurationResource, getDependencyNames, getDependentVersion, getEvictionNames, getFileSystemName, getFileSystemShortName, getLoadAfterNames, getLoadBeforeNames, getManager, getName, getPluginClass, getPluginPath, getPluginPathCamelCase, getPropertySource, getVersion, getWatchedResourcePatterns, hasInterestInChange, hashCode, isBasePlugin, isEnabled, readPluginConfiguration, refresh, setApplication, setApplicationContext, setBasePlugin, setManager`

- Field Detail
  - protected static final org.apache.commons.logging.Log LOG
  - protected org.springframework.beans.BeanWrapper pluginBean
- Constructor Detail
  - public DefaultGrailsPlugin(java.lang.Class<?> pluginClass, org.springframework.core.io.Resource resource, GrailsApplication application)
  - public DefaultGrailsPlugin(java.lang.Class<?> pluginClass, GrailsApplication application)
- Method Detail
  - public void addExclude(Environment env)
  - public BeanBuilder beans(groovy.lang.Closure closure)
  - @java.lang.Override public java.lang.Object call(java.lang.Object arguments)
  - public void doArtefactConfiguration()
  - public void doWithApplicationContext(org.springframework.context.ApplicationContext ctx)
  - public void doWithDynamicMethods(org.springframework.context.ApplicationContext ctx)
  - public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)
  - @java.lang.Deprecated public void doc(java.lang.String text)
    
    deprecated:
    Dynamic document generation no longer supported
    
    Parameters:
    text
  - @java.lang.Override public java.lang.String[] getDependencyNames()
  - @java.lang.Override public java.lang.String getDependentVersion(java.lang.String name)
  - public Resource getDescriptor()
  - public java.lang.String getFullName()
  - public groovy.lang.GroovyObject getInstance()
  - @java.lang.Override public java.lang.String[] getLoadAfterNames()
  - @java.lang.Override public java.lang.String[] getLoadBeforeNames()
  - public org.apache.commons.logging.Log getLog()
  - @java.lang.Override public java.lang.String getName()
  - public java.lang.String[] getObservedPluginNames()
  - public org.springframework.context.ApplicationContext getParentCtx()
  - public GrailsPlugin getPlugin()
  - public Resource getPluginDir()
  - public java.util.List<java.lang.String> getPluginExcludes()
  - public java.util.Map getProperties()
  - public java.lang.Class<?>[] getProvidedArtefacts()
  - public org.springframework.core.io.support.PathMatchingResourcePatternResolver getResolver()
    
    Returns:
    the resolver
  - public java.util.Collection<? extends org.springframework.core.type.filter.TypeFilter> getTypeFilters()
  - @java.lang.Override public java.util.List<WatchPattern> getWatchedResourcePatterns()
  - public org.springframework.core.io.Resource[] getWatchedResources()
    
    Returns:
    the watchedResources
  - @java.lang.Override public boolean hasInterestInChange(java.lang.String path)
  - @java.lang.Override public boolean isEnabled(java.lang.String[] activeProfiles)
  - public boolean isEnabled()
  - public void notifyOfEvent(java.util.Map event)
  - public java.util.Map notifyOfEvent(int eventKind, java.lang.Object source)
  - @java.lang.Override public void refresh()
  - @java.lang.Override public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
  - public void setDescriptor(org.springframework.core.io.Resource descriptor)
  - @java.lang.Override public void setManager(GrailsPluginManager manager)
  - public void setParentApplicationContext(org.springframework.context.ApplicationContext parent)
  - public void setWatchedResources(org.springframework.core.io.Resource[] watchedResources)
  - public boolean supportsCurrentScopeAndEnvironment()
  - public boolean supportsEnvironment(Environment environment)
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class DefaultGrailsPlugin

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final org.apache.commons.logging.Log LOG

protected org.springframework.beans.BeanWrapper pluginBean

Constructor Detail

public DefaultGrailsPlugin(java.lang.Class<?> pluginClass, org.springframework.core.io.Resource resource, GrailsApplication application)

public DefaultGrailsPlugin(java.lang.Class<?> pluginClass, GrailsApplication application)

Method Detail

public void addExclude(Environment env)

public BeanBuilder beans(groovy.lang.Closure closure)

@java.lang.Override public java.lang.Object call(java.lang.Object arguments)

public void doArtefactConfiguration()

public void doWithApplicationContext(org.springframework.context.ApplicationContext ctx)

public void doWithDynamicMethods(org.springframework.context.ApplicationContext ctx)

public void doWithRuntimeConfiguration(RuntimeSpringConfiguration springConfig)

@java.lang.Deprecated public void doc(java.lang.String text)

@java.lang.Override public java.lang.String[] getDependencyNames()

@java.lang.Override public java.lang.String getDependentVersion(java.lang.String name)

public Resource getDescriptor()

public java.lang.String getFullName()

public groovy.lang.GroovyObject getInstance()

@java.lang.Override public java.lang.String[] getLoadAfterNames()

@java.lang.Override public java.lang.String[] getLoadBeforeNames()

public org.apache.commons.logging.Log getLog()

@java.lang.Override public java.lang.String getName()

public java.lang.String[] getObservedPluginNames()

public org.springframework.context.ApplicationContext getParentCtx()

public GrailsPlugin getPlugin()

public Resource getPluginDir()

public java.util.List<java.lang.String> getPluginExcludes()

public java.util.Map getProperties()

public java.lang.Class<?>[] getProvidedArtefacts()

public org.springframework.core.io.support.PathMatchingResourcePatternResolver getResolver()

public java.util.Collection<? extends org.springframework.core.type.filter.TypeFilter> getTypeFilters()

@java.lang.Override public java.util.List<WatchPattern> getWatchedResourcePatterns()

public org.springframework.core.io.Resource[] getWatchedResources()

@java.lang.Override public boolean hasInterestInChange(java.lang.String path)

@java.lang.Override public boolean isEnabled(java.lang.String[] activeProfiles)

public boolean isEnabled()

public void notifyOfEvent(java.util.Map event)

public java.util.Map notifyOfEvent(int eventKind, java.lang.Object source)

@java.lang.Override public void refresh()

@java.lang.Override public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

public void setDescriptor(org.springframework.core.io.Resource descriptor)

@java.lang.Override public void setManager(GrailsPluginManager manager)

public void setParentApplicationContext(org.springframework.context.ApplicationContext parent)

public void setWatchedResources(org.springframework.core.io.Resource[] watchedResources)

public boolean supportsCurrentScopeAndEnvironment()

public boolean supportsEnvironment(Environment environment)

@java.lang.Override public java.lang.String toString()