org.andromda.core.common

Interface Plugin

All Superinterfaces:

NamespaceComponent

All Known Implementing Classes:

BasePlugin, Cartridge, Library

public interface Plugin
extends NamespaceComponent

Interface between an AndroMDA code generator plugin and the core. All plug-ins (such as cartridges and translation-libraries) that can be discovered and used by the framework must implement this interface.

Author:

Matthias Bohlen , Chad Brandon, Bob Fields

Method Summary

Methods

Modifier and Type	Method and Description
List	getContents() Returns a list containing the name of each resource contained within the plugin.
String[]	getPropertyReferences() Gets all property references available for this cartridge.
TemplateEngine	getTemplateEngine() Gets the TemplateEngine which implements the template processing.
Collection<TemplateObject>	getTemplateObjects() Returns all the TemplateObject objects that are available to this Plugin.
void	initialize() Initializes the plugin.
void	shutdown() Shuts down the plugin.

Methods inherited from interface org.andromda.core.namespace.NamespaceComponent

getNamespace, getResource, setNamespace, setResource

Method Detail

initialize

void initialize()
                throws Exception

Initializes the plugin.

Throws:

Exception

shutdown

void shutdown()

Shuts down the plugin. The meaning of this is defined by the plugin itself. At least, it should close any logfiles.

getTemplateObjects

Collection<TemplateObject> getTemplateObjects()

Returns all the TemplateObject objects that are available to this Plugin.

Returns:

a collection of TemplateObjects.

getTemplateEngine

TemplateEngine getTemplateEngine()

Gets the TemplateEngine which implements the template processing.

Returns:

TemplateEngine

See Also:

TemplateEngine

getPropertyReferences

String[] getPropertyReferences()

Gets all property references available for this cartridge. This is an array of names corresponding to property references.

Returns:

the Map of property references.

getContents

List getContents()

Returns a list containing the name of each resource contained within the plugin.

Returns:

contents