com.serotonin.m2m2.module
Class ModuleElementDefinition

java.lang.Object
  com.serotonin.m2m2.module.ModuleElementDefinition

Direct Known Subclasses:

AuditEventTypeDefinition, DatabaseSchemaDefinition, DataPointChangeDefinition, DataSourceDefinition, DwrConversionDefinition, DwrDefinition, EmportDefinition, EventManagerListenerDefinition, EventTypeDefinition, FiledataDefinition, LongPollDefinition, PublisherDefinition, PurgeDefinition, RuntimeManagerDefinition, ServletDefinition, SystemEventTypeDefinition, SystemSettingsDefinition, UrlMappingDefinition

public abstract class ModuleElementDefinition
extends java.lang.Object

The base level of a module definition class. In general this class should not be directly extended. Instead, the sub classes should be extended since it is the sub classes that will be recognized and handled upon startup. Other classes will be ignored.

Author:

Matthew Lohbihler

Constructor Summary

ModuleElementDefinition()

Method Summary

Module	getModule() Access to the module class that owns this definition.
void	initialize()
void	uninstall() This method is run once at shutdown if the owning module has been marked for deletion.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleElementDefinition

public ModuleElementDefinition()

Method Detail

getModule

public Module getModule()

Access to the module class that owns this definition.

Returns:

the definition's module

initialize

public void initialize()

uninstall

public void uninstall()

This method is run once at shutdown if the owning module has been marked for deletion. This provides the definition class an opportunity to perform any necessary cleanup, such as dropping database tables, removing files, etc.