public abstract class AbstractModule extends DefaultModuleInfo implements Module
The module can be specified in an external property file. The file name of this specification defaults to "module.properties". This file is no real property file, it follows a more complex rule set.
Lines starting with '#' are considered comments. Section headers start at the beginning of the line, section properties are indented with at least one whitespace.
The first section is always the module info and contains the basic module properties like name, version and a short description.
module-info: name: xls-export-gui producer: The JFreeReport project - www.jfree.org/jfreereport description: A dialog component for the Excel table export. version.major: 0 version.minor: 84 version.patchlevel: 0The properties name, producer and description are simple strings. They may span multiple lines, but may not contain a colon (':'). The version properties are integer values.
This section may be followed by one or more "depends" sections. These sections describe the base modules that are required to be active to make this module work. The package manager will enforce this policy and will deactivate this module if one of the base modules is missing.
depends: module: org.jfree.report.modules.output.table.xls.XLSTableModule version.major: 0 version.minor: 84
The property module references to the module implementation of the module package.
Constructor and Description |
---|
AbstractModule()
Default Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
configure(SubSystem subSystem)
Configures the module by loading the configuration properties and
adding them to the package configuration.
|
String |
getDescription()
Returns the module description.
|
String |
getName()
Returns the name of this module.
|
ModuleInfo[] |
getOptionalModules()
Returns a copy of the required modules array.
|
String |
getProducer()
Returns the producer of the module.
|
ModuleInfo[] |
getRequiredModules()
Returns a copy of the required modules array.
|
String |
getSubSystem()
Returns the modules subsystem.
|
protected static boolean |
isClassLoadable(String name)
Deprecated.
use the method that passes in a context-class.
|
protected static boolean |
isClassLoadable(String name,
Class context)
Tries to load a class to indirectly check for the existence
of a certain library.
|
protected void |
loadModuleInfo()
Loads the default module description from the file "module.properties".
|
protected void |
loadModuleInfo(InputStream in)
Loads the module descriptiong from the given input stream.
|
protected void |
performExternalInitialize(String classname)
Deprecated.
Use the method that provides a class-context instead.
|
protected void |
performExternalInitialize(String classname,
Class context)
???.
|
protected void |
setDescription(String description)
Defines the description of the module.
|
protected void |
setName(String name)
Defines the name of the module.
|
void |
setOptionalModules(ModuleInfo[] optionalModules)
Defines the optional module descriptions for this module.
|
protected void |
setProducer(String producer)
Defines the producer of the module.
|
protected void |
setRequiredModules(ModuleInfo[] requiredModules)
Defines the required module descriptions for this module.
|
protected void |
setSubSystem(String name)
Defines the subsystem name for this module.
|
String |
toString()
Returns a string representation of this module.
|
equals, getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel, hashCode, setMajorVersion, setMinorVersion, setModuleClass, setPatchLevel
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
initialize
getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel
protected void loadModuleInfo() throws ModuleInitializeException
ModuleInitializeException
- if an error occurs.protected void loadModuleInfo(InputStream in) throws ModuleInitializeException
in
- the input stream from where to read the fileModuleInitializeException
- if an error occurs.public String getName()
getName
in interface Module
Module.getName()
protected void setName(String name)
name
- the module name.public String getDescription()
getDescription
in interface Module
Module.getDescription()
protected void setDescription(String description)
description
- the module's desciption.public String getProducer()
getProducer
in interface Module
Module.getProducer()
protected void setProducer(String producer)
producer
- the producer.public ModuleInfo[] getRequiredModules()
getRequiredModules
in interface Module
Module.getRequiredModules()
public ModuleInfo[] getOptionalModules()
getOptionalModules
in interface Module
Module.getRequiredModules()
protected void setRequiredModules(ModuleInfo[] requiredModules)
requiredModules
- the required modules.public void setOptionalModules(ModuleInfo[] optionalModules)
optionalModules
- the optional modules.public String toString()
toString
in class DefaultModuleInfo
Object.toString()
protected static boolean isClassLoadable(String name)
name
- the name of the library class.protected static boolean isClassLoadable(String name, Class context)
name
- the name of the library class.context
- the context class to get a classloader from.public void configure(SubSystem subSystem)
protected void performExternalInitialize(String classname) throws ModuleInitializeException
classname
- the class name of the initializer.ModuleInitializeException
- if an error occuresprotected void performExternalInitialize(String classname, Class context) throws ModuleInitializeException
classname
- ?context
- ?ModuleInitializeException
- if there is an initialisation error.public String getSubSystem()
getSubSystem
in interface Module
protected void setSubSystem(String name)
name
- the new name of the subsystem.Copyright © 2001–2017 JFree.org. All rights reserved.