com.serotonin.m2m2.module
Class Module

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

public class Module
extends java.lang.Object

All information regarding a module required by the core.

Author:

Matthew Lohbihler

Constructor Summary

Module(java.lang.String name, java.lang.String version, com.serotonin.m2m2.i18n.TranslatableMessage description, java.lang.String vendor, java.lang.String vendorUrl, java.lang.String dependencies)
Module constructor.

Method Summary

void	addDefinition(ModuleElementDefinition definition)
void	addLicenseDefinition(LicenseDefinition def)
void	addLocaleDefinition(java.lang.String locale)
<T extends ModuleElementDefinition> java.util.List<T>	getDefinitions(java.lang.Class<T> clazz)
java.lang.String	getDependencies()
com.serotonin.m2m2.i18n.TranslatableMessage	getDescription()
java.lang.String	getDirectoryPath()
java.lang.String	getEmailTemplatesDir()
java.lang.String	getGraphicsDir()
java.util.List<LicenseDefinition>	getLicenseDefinitions()
java.util.List<com.serotonin.m2m2.i18n.TranslatableMessage>	getLicenseErrors()
java.util.List<com.serotonin.m2m2.i18n.TranslatableMessage>	getLicenseWarnings()
java.util.Set<java.lang.String>	getLocales()
java.lang.String	getName()
java.lang.String	getVendor()
java.lang.String	getVendorUrl()
java.lang.String	getVersion()
java.lang.String	getWebPath()
boolean	isMarkedForDeletion()
void	setEmailTemplatesDir(java.lang.String emailTemplates)
void	setGraphicsDir(java.lang.String dir)
void	setMarkedForDeletion(boolean markedForDeletion)
static void	sortByName(java.util.List<Module> modules)
void	uninstall() Called upon shutdown on modules that have been marked for deletion.

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

public Module(java.lang.String name,
              java.lang.String version,
              com.serotonin.m2m2.i18n.TranslatableMessage description,
              java.lang.String vendor,
              java.lang.String vendorUrl,
              java.lang.String dependencies)

Module constructor. Should not be used by client code.

Parameters:

name -

version -

description -

vendor -

vendorUrl -

Method Detail

sortByName

public static final void sortByName(java.util.List<Module> modules)

getDirectoryPath

public java.lang.String getDirectoryPath()

Returns:

the path from the m2m2 home to the module's directory. Suitable for creating File objects within Java code

getWebPath

public java.lang.String getWebPath()

Returns:

the path from m2m2's web root to the module's directory. Suitable for creating URLs to module assets.

uninstall

public void uninstall()

Called upon shutdown on modules that have been marked for deletion. Should not be used by client code.

getName

public java.lang.String getName()

Returns:

the module's name

getVersion

public java.lang.String getVersion()

Returns:

the module's version

getDescription

public com.serotonin.m2m2.i18n.TranslatableMessage getDescription()

getVendor

public java.lang.String getVendor()

getVendorUrl

public java.lang.String getVendorUrl()

getDependencies

public java.lang.String getDependencies()

isMarkedForDeletion

public boolean isMarkedForDeletion()

setMarkedForDeletion

public void setMarkedForDeletion(boolean markedForDeletion)

addDefinition

public void addDefinition(ModuleElementDefinition definition)

getDefinitions

public <T extends ModuleElementDefinition> java.util.List<T> getDefinitions(java.lang.Class<T> clazz)

addLicenseDefinition

public void addLicenseDefinition(LicenseDefinition def)

getLicenseDefinitions

public java.util.List<LicenseDefinition> getLicenseDefinitions()

getLicenseErrors

public java.util.List<com.serotonin.m2m2.i18n.TranslatableMessage> getLicenseErrors()

getLicenseWarnings

public java.util.List<com.serotonin.m2m2.i18n.TranslatableMessage> getLicenseWarnings()

addLocaleDefinition

public void addLocaleDefinition(java.lang.String locale)

getLocales

public java.util.Set<java.lang.String> getLocales()

setGraphicsDir

public void setGraphicsDir(java.lang.String dir)

getGraphicsDir

public java.lang.String getGraphicsDir()

getEmailTemplatesDir

public java.lang.String getEmailTemplatesDir()

setEmailTemplatesDir

public void setEmailTemplatesDir(java.lang.String emailTemplates)