Overview  Package   Class  Use  Deprecated  Index
Home >> All >> irate >> [ plugin overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

irate.plugin
Class Plugin  

java.lang.Object
  irate.plugin.Plugin

---

public abstract class Plugin

extends java.lang.Object

Base class for all plugins.

---

Field Summary
private  PluginApplication	app

 

Constructor Summary

Plugin()

 

Method Summary
void	attach(PluginApplication app)           Attach the plugin to the specified application.
void	detach()           Detach the plugin from the application.
protected abstract  void	doAttach()           Subclasses to override to do real work of attaching.
protected abstract  void	doDetach()           Subclasses to override to do real work of detaching.
abstract  void	formatConfig(nanoxml.XMLElement elt)           Format the configuration of this plugin by modifying the specified element.
protected  PluginApplication	getApp()           Get access to the application instance.
abstract  java.lang.String	getDescription()           Get a short description of this plugin.
abstract  java.lang.String	getIdentifier()           Get a short identifier for this Plugin.
boolean	isAttached()
abstract  void	parseConfig(nanoxml.XMLElement elt)           Parse the configuration stored in the specified element.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

app

private PluginApplication app

Constructor Detail

Plugin

public Plugin()

Method Detail

getIdentifier

public abstract java.lang.String getIdentifier()

Get a short identifier for this Plugin.

---

getDescription

public abstract java.lang.String getDescription()

Get a short description of this plugin.

---

isAttached

public final boolean isAttached()

---

getApp

protected final PluginApplication getApp()

Get access to the application instance.

---

attach

public final void attach(PluginApplication app)

Attach the plugin to the specified application.

---

doAttach

protected abstract void doAttach()

Subclasses to override to do real work of attaching. Application is available through getApp().

---

detach

public final void detach()

Detach the plugin from the application.

---

doDetach

protected abstract void doDetach()

Subclasses to override to do real work of detaching. Application is available through getApp().

---

parseConfig

public abstract void parseConfig(nanoxml.XMLElement elt)

Parse the configuration stored in the specified element.

---

formatConfig

public abstract void formatConfig(nanoxml.XMLElement elt)

Format the configuration of this plugin by modifying the specified element.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> irate >> [ plugin overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---