com.lf.commons.plugin

Class PlugInDef

java.lang.Object

com.lf.commons.plugin.PlugInDef

public class PlugInDef
extends java.lang.Object

Simple data holding class for use with plugin Hashtable objects.

Holds just five public attribute variables for direct access. The variable pseudonym holds a user-definable short name for the module held by this class (variable 'plugin'). The variable identifier holds a unique numerical identifier generated by the KAT system. This helps it to identify each module. The field classname provides the fully qualified name of the class the plugin module is instantiated from. The classpath field finally provides the class path which the class may be found.

All these values are directly accessed by the KAT system so this class seems not to be for general but for local purpose. Since the plugin field holds the common Object class type you may set any instance of proper Java classes.

Since:

1.5

Version:

$Revision: 1.10 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classname This holds the fully qualified class name of the plugin module.
java.lang.String	classpath Path where the plugin module was loaded from.
java.lang.String	identifier Each plugin module has a unique identifier (numerical).
java.lang.Object	plugin Reference to the plugin module itself.
java.lang.String	pseudonym The users may give plugin modules (unique) names.

Constructor Summary

Constructors

Constructor and Description
PlugInDef() Constructor method for i18n purposes only.
PlugInDef(java.lang.String pseudonym, java.lang.String identifier, java.lang.String classname, java.lang.String classpath, java.lang.Object plugin) Init functionality.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(PlugInDef tocheck) Checks wether a given PlugInDef instance is equal to this.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pseudonym

public java.lang.String pseudonym

The users may give plugin modules (unique) names.

identifier

public java.lang.String identifier

Each plugin module has a unique identifier (numerical).

classname

public java.lang.String classname

This holds the fully qualified class name of the plugin module.

classpath

public java.lang.String classpath

Path where the plugin module was loaded from.

plugin

public java.lang.Object plugin

Reference to the plugin module itself.

Constructor Detail

PlugInDef

public PlugInDef()
          throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

PlugInDef

public PlugInDef(java.lang.String pseudonym,
         java.lang.String identifier,
         java.lang.String classname,
         java.lang.String classpath,
         java.lang.Object plugin)

Init functionality.

Parameters:

pseudonym - The user definable name

identifier - The unique identifier for directories

classname - The fully qualified name of the class

classpath - The class path to access it

plugin - An instance reference

Since:

1.5

Method Detail

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Returns the plugin pseudonym String because this has to be unique in CARAMEL. Always generates a non-null String object as result.

Overrides:

toString in class java.lang.Object

Returns:

The pseudonym of the plugin

Since:

1.5

equals

public boolean equals(PlugInDef tocheck)

Checks wether a given PlugInDef instance is equal to this.

Parameters:

tocheck - Instance to be checked

Returns:

The PlugInDef instance to check for equality

Since:

1.5