com.unitesk.atp.tool
Interface Plugin

All Known Implementing Classes:

Action, Attribute, DumpAction, Plugin, PluginClass

public interface Plugin

Plugin is a functionality extention module.

Version:

$Id: Plugin.java,v 1.1 2004/10/09 06:43:21 all-x Exp $

Author:

Alexey Demakov

Method Summary

String	getKind() Returns the type of plugin - action, attribute etc.
String	getName() Returns plugin name.
Object	getPlugin(String name) Returns plugin with the specified name.
PluginManager	getPluginManager() Gets plugin manager for this plugin.
String	getProperty(String name) Gets the value of a plugin property with the specified name.
String	getProperty(String name, String value) Gets the value of a plugin property with the specified name or the specified default value if this property is not defined.
String	getPropertyName(String name) Gets the name of a system property for the specified plugin property.
String	getVersion() Returns plugin version.
void	init(PluginManager pm, String name) Links this plugin to the specified plugin manager.

Method Detail

getKind

String getKind()

Returns the type of plugin - action, attribute etc.

getName

String getName()

Returns plugin name.

Returns:

plugin name

getVersion

String getVersion()

Returns plugin version.

init

void init(PluginManager pm,
          String name)

Links this plugin to the specified plugin manager. Must be called before plugin usage.

Parameters:

pm - The plugin manager to link plugin to.

name - The name of plugin.

getPlugin

Object getPlugin(String name)

Returns plugin with the specified name. Any object can be plugin.

Parameters:

name - The name of plugin.

getPropertyName

String getPropertyName(String name)

Gets the name of a system property for the specified plugin property.

Parameters:

name - The name of a plugin property.

Returns:

The name of a system property.

getProperty

String getProperty(String name)

Gets the value of a plugin property with the specified name.

Parameters:

name - The name of a plugin property.

Returns:

The value of a plugin property with the specified name.

getProperty

String getProperty(String name,
                   String value)

Gets the value of a plugin property with the specified name or the specified default value if this property is not defined.

Parameters:

name - The name of a plugin property.

value - The default value of a property.

Returns:

The value of a plugin property with the specified name.

getPluginManager

PluginManager getPluginManager()

Gets plugin manager for this plugin.

Returns:

The plugin manager for this plugin