org.intellimate.izou.sdk.addon

Class AddOn

java.lang.Object

org.intellimate.izou.sdk.addon.AddOn

All Implemented Interfaces:

AddOnModel, Identifiable, ContextProvider, Loggable, LoggedExceptionCallback, ExceptionCallback, ro.fortsoft.pf4j.ExtensionPoint

public abstract class AddOn
extends Object
implements AddOnModel, ContextProvider, Loggable, LoggedExceptionCallback

All AddOns must extend this Class. It will be instantiated and its registering-methods will be called by the PluginManager. This class has method for a properties-file named addOnID.properties (AddOnsID in the form: package.class)

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
AddOn(String addOnID) The default constructor for AddOns

Method Summary

Modifier and Type	Method and Description
Context	getContext() Returns the Context of the AddOn.
String	getID() An ID must always be unique.
ro.fortsoft.pf4j.PluginWrapper	getPlugin() Gets the associated Plugin.
void	initAddOn(Context context) Internal initiation of addOn - fake constructor, comes before prepare
abstract void	prepare() This method gets called before registering
void	register() This method is used to register the modules
abstract ActivatorModel[]	registerActivator() Use this method to register (if needed) your Activators.
abstract ContentGenerator[]	registerContentGenerator() Use this method to register (if needed) your ContentGenerators.
abstract EventsControllerModel[]	registerEventController() Use this method to register (if needed) your EventControllers.
abstract OutputExtensionModel[]	registerOutputExtension() Use this method to register (if needed) your Output.
abstract OutputPluginModel[]	registerOutputPlugin() Use this method to register (if needed) your OutputPlugins.
void	setPlugin(ro.fortsoft.pf4j.PluginWrapper plugin) Sets the Plugin IF it is not already set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Constructor Detail

AddOn

public AddOn(String addOnID)

The default constructor for AddOns

Parameters:

addOnID - the ID of the Plugin in the form: package.class

Method Detail

register

public void register()

This method is used to register the modules

Specified by:

register in interface AddOnModel

prepare

public abstract void prepare()

This method gets called before registering

registerActivator

public abstract ActivatorModel[] registerActivator()

Use this method to register (if needed) your Activators.

Returns:

Array containing Instances of Activators

registerContentGenerator

public abstract ContentGenerator[] registerContentGenerator()

Use this method to register (if needed) your ContentGenerators.

Returns:

Array containing Instances of ContentGenerators

registerEventController

public abstract EventsControllerModel[] registerEventController()

Use this method to register (if needed) your EventControllers.

Returns:

Array containing Instances of EventControllers

registerOutputPlugin

public abstract OutputPluginModel[] registerOutputPlugin()

Use this method to register (if needed) your OutputPlugins.

Returns:

Array containing Instances of OutputPlugins

registerOutputExtension

public abstract OutputExtensionModel[] registerOutputExtension()

Use this method to register (if needed) your Output.

Returns:

Array containing Instances of OutputExtensions

initAddOn

public void initAddOn(Context context)

Internal initiation of addOn - fake constructor, comes before prepare

Specified by:

initAddOn in interface AddOnModel

Parameters:

context - the context to initialize with

getContext

public Context getContext()

Returns the Context of the AddOn. Context provides some general Communications.

Specified by:

getContext in interface ContextProvider

Returns:

an instance of Context.

getPlugin

public ro.fortsoft.pf4j.PluginWrapper getPlugin()

Gets the associated Plugin.

Specified by:

getPlugin in interface AddOnModel

Returns:

the Plugin.

setPlugin

public void setPlugin(ro.fortsoft.pf4j.PluginWrapper plugin)

Sets the Plugin IF it is not already set.

Specified by:

setPlugin in interface AddOnModel

Parameters:

plugin - the plugin

getID

public String getID()

An ID must always be unique. A Class like Activator or OutputPlugin can just provide their .class.getCanonicalName() If you have to implement this interface multiple times, just concatenate unique Strings to .class.getCanonicalName()

Specified by:

getID in interface Identifiable

Returns:

A String containing an ID