Package de.willuhn.jameica.plugin
Class AbstractPlugin
- java.lang.Object
-
- de.willuhn.jameica.plugin.AbstractPlugin
-
-
Constructor Summary
Constructors Constructor Description AbstractPlugin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ManifestgetManifest()Liefert das Manifest des Plugins.PluginResourcesgetResources()Liefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.voidinit()Diese Funktion wird beim Start der Anwendung ausgefuehrt.voidinstall()Diese Funktion wird beim Start der Anwendung aufgerufen, wenn das Plugin zum ersten mal gestartet wird.voidshutDown()Diese Funktion wird beim Beenden der Anwendung ausgefuehrt.voiduninstall(boolean deleteUserData)Wird aufgerufen, wenn das Plugin ueber Datei->Einstellungen->Plugins deinstalliert wird.voidupdate(Version oldVersion)Diese Funktion wird beim Start der Anwendung genau dann aufgerufen, wenn das Plugin bereits erfolgreich installiert wurde, jedoch jetzt in einer anderen Version vorliegt als die vorherige.
-
-
-
Method Detail
-
getResources
public final PluginResources getResources()
Description copied from interface:PluginLiefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.- Specified by:
getResourcesin interfacePlugin- Returns:
- Resource-Pack.
- See Also:
Plugin.getResources()
-
getManifest
public final Manifest getManifest()
Description copied from interface:PluginLiefert das Manifest des Plugins.- Specified by:
getManifestin interfacePlugin- Returns:
- Manifest.
- See Also:
Plugin.getManifest()
-
init
public void init() throws de.willuhn.util.ApplicationExceptionDescription copied from interface:PluginDiese Funktion wird beim Start der Anwendung ausgefuehrt. Hier kann die Plugin- Implementierung also diverse Dinge durchfuehren, die es beim Start gern automatisch durchgefuehrt haben moechte. Nur wenn die Funktion fehlerfrei durchlaeuft, wird das Plugin aktiviert. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.- Specified by:
initin interfacePlugin- Throws:
de.willuhn.util.ApplicationException- muss geworfen werden, wenn das Plugin nicht aktiviert werden soll.- See Also:
Plugin.init()
-
install
public void install() throws de.willuhn.util.ApplicationExceptionDescription copied from interface:PluginDiese Funktion wird beim Start der Anwendung aufgerufen, wenn das Plugin zum ersten mal gestartet wird. Die install() Funktion wird solange bei jedem Start aufgerufen, bis sie fehlerfrei durchlaeuft. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.- Specified by:
installin interfacePlugin- Throws:
de.willuhn.util.ApplicationException- muss geworfen werden, wenn die Installation fehlschlug und das Plugin nicht aktiviert werden soll.- See Also:
Plugin.install()
-
update
public void update(Version oldVersion) throws de.willuhn.util.ApplicationException
Description copied from interface:PluginDiese Funktion wird beim Start der Anwendung genau dann aufgerufen, wenn das Plugin bereits erfolgreich installiert wurde, jedoch jetzt in einer anderen Version vorliegt als die vorherige. Sie wird solange bei jedem Start aufgerufen, bis sie fehlerfrei durchlaeuft. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.- Specified by:
updatein interfacePlugin- Parameters:
oldVersion- Version, die vorher installiert war.- Throws:
de.willuhn.util.ApplicationException- muss geworfen werden, wenn das Update fehlschlug und das Plugin nicht aktiviert werden soll.- See Also:
Plugin.update(de.willuhn.jameica.plugin.Version)
-
shutDown
public void shutDown()
Description copied from interface:PluginDiese Funktion wird beim Beenden der Anwendung ausgefuehrt.- Specified by:
shutDownin interfacePlugin- See Also:
Plugin.shutDown()
-
uninstall
public void uninstall(boolean deleteUserData) throws de.willuhn.util.ApplicationExceptionDescription copied from interface:PluginWird aufgerufen, wenn das Plugin ueber Datei->Einstellungen->Plugins deinstalliert wird. Hier kann das Plugin bei Bedarf eigene Aufraeum-Arbeiten durchfuehren. VOR dem Aufruf dieser Funktion wird "shutDown" aufgerufen. Falls dort also z.Bsp. Datenbankverbindungen geschlossen wurden, dann stehen diese hier nicht mehr zur Verfuegung.- Specified by:
uninstallin interfacePlugin- Parameters:
deleteUserData- true, wenn der User bei der Deinstallation angegeben hat, dass auch die Benutzer-Daten des Plugins geloescht werden sollen.- Throws:
de.willuhn.util.ApplicationException- kann geworfen werden, um die Deinstallation abzubrechen.- See Also:
Plugin.uninstall(boolean)
-
-