org.codehaus.groovy.grails.plugins

Class BinaryGrailsPlugin

java.lang.Object

GroovyObjectSupport

org.codehaus.groovy.grails.plugins.AbstractGrailsPlugin

org.codehaus.groovy.grails.plugins.DefaultGrailsPlugin

org.codehaus.groovy.grails.plugins.BinaryGrailsPlugin

All Implemented Interfaces:

java.lang.Comparable, GrailsPlugin, ParentApplicationContextAware

public class BinaryGrailsPlugin
extends DefaultGrailsPlugin

Models a pre-compiled binary plugin.

Since:

2.0

Author:

Graeme Rocher

See Also:

GrailsPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_MESSAGES_PROPERTIES
static java.lang.String	VIEWS_PROPERTIES

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

ARTEFACTS, DEPENDS_ON, DO_WITH_APPLICATION_CONTEXT, DO_WITH_DYNAMIC_METHODS, DO_WITH_SPRING, DO_WITH_WEB_DESCRIPTOR, ENVIRONMENTS, EVENT_ON_CHANGE, EVENT_ON_CONFIG_CHANGE, EVENT_ON_SHUTDOWN, EVICT, INFLUENCES, ON_CHANGE, ON_CONFIG_CHANGE, ON_SHUTDOWN, PLUGIN_EXCLUDES, PLUGIN_LOAD_AFTER_NAMES, PLUGIN_LOAD_BEFORE_NAMES, PLUGINS_PATH, PROVIDED_ARTEFACTS, SCOPES, STATUS, STATUS_DISABLED, STATUS_ENABLED, TYPE_FILTERS, WATCHED_RESOURCES

Constructor Summary

Constructors

Constructor and Description
BinaryGrailsPlugin(java.lang.Class<?> pluginClass, BinaryGrailsPluginDescriptor descriptor, GrailsApplication application) Creates a binary plugin instance.

Method Summary

Modifier and Type	Method and Description
BinaryGrailsPluginDescriptor	getBinaryDescriptor()
java.util.Properties	getProperties(java.util.Locale locale) Obtains all properties for this binary plugin for the given locale.
java.lang.Class<?>[]	getProvidedArtefacts() Retrieves an array of provided Artefacts that are pre-compiled additions to the GrailsApplication object but are overridable by the end-user
Resource	getResource(java.lang.String path) Resolves a static resource contained within this binary plugin
java.lang.Class	resolveView(java.lang.String viewName) Resolves a view for the given view name.

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

addExclude, addExclude, beans, checkForChanges, doArtefactConfiguration, doc, doWithApplicationContext, doWithDynamicMethods, doWithRuntimeConfiguration, doWithWebDescriptor, getDependencyNames, getDependentVersion, getDescriptor, getFullName, getInstance, getLoadAfterNames, getLoadBeforeNames, getLog, getName, getObservedPluginNames, getParentCtx, getPlugin, getPluginDir, getPluginExcludes, getProperties, getResolver, getTypeFilters, getWatchedResourcePatterns, getWatchedResources, hasInterestInChange, isEnabled, notifyOfEvent, notifyOfEvent, refresh, restartContainer, setDescriptor, setParentApplicationContext, setWatchedResources, supportsCurrentScopeAndEnvironment, supportsEnvironment, supportsScope, toString

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

compareTo, equals, getEvictionNames, getFileSystemName, getFileSystemShortName, getManager, getPluginClass, getPluginPath, getVersion, hashCode, isBasePlugin, setApplication, setApplicationContext, setBasePlugin, setManager

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

BASE_MESSAGES_PROPERTIES

public static final java.lang.String BASE_MESSAGES_PROPERTIES

See Also:

Constant Field Values

VIEWS_PROPERTIES

public static final java.lang.String VIEWS_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

BinaryGrailsPlugin

public BinaryGrailsPlugin(java.lang.Class<?> pluginClass,
                          BinaryGrailsPluginDescriptor descriptor,
                          GrailsApplication application)

Creates a binary plugin instance.

Parameters:

pluginClass - The plugin class

descriptor - The META-INF/grails-plugin.xml descriptor

application - The application

Method Detail

getProvidedArtefacts

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

Description copied from interface: GrailsPlugin

Retrieves an array of provided Artefacts that are pre-compiled additions to the GrailsApplication object but are overridable by the end-user

Specified by:

getProvidedArtefacts in interface GrailsPlugin

Overrides:

getProvidedArtefacts in class DefaultGrailsPlugin

Returns:

A list of provided artefacts

getBinaryDescriptor

public BinaryGrailsPluginDescriptor getBinaryDescriptor()

Returns:

The META-INF/grails-plugin.xml descriptor

getResource

public Resource getResource(java.lang.String path)

Resolves a static resource contained within this binary plugin

Parameters:

path - The relative path to the static resource

Returns:

The resource or null if it doesn't exist

getProperties

public java.util.Properties getProperties(java.util.Locale locale)

Obtains all properties for this binary plugin for the given locale. Note this method does not cache so clients should in general cache the results of this method.

Parameters:

locale - The locale

Returns:

The properties or null if non exist

resolveView

public java.lang.Class resolveView(java.lang.String viewName)

Resolves a view for the given view name.

Parameters:

viewName - The view name

Returns:

The view class which is a subclass of GroovyPage