| org.jfree.base.modules.Module
All known Subclasses: org.jfree.base.modules.AbstractModule,
| Module | | public interface Module extends ModuleInfo(Code) | | A module encapsulates optional functionality within a project. Modules can
be used as an easy way to make projects more configurable.
The module system provides a controled way to check dependencies and to initialize
the modules in a controlled way.
author:
Thomas Morgner |
| configure | | public void configure(SubSystem subSystem)(Code) | | Configures the module. This should load the default settings of the module.
Parameters:
subSystem - the subSystem. |
| getDescription | | public String getDescription()(Code) | | Returns a short description of the modules functionality.
a module description. |
| getName | | public String getName()(Code) | | Returns the module name. This name should be a short descriptive handle of the
module.
the module name |
| getOptionalModules | | public ModuleInfo[] getOptionalModules()(Code) | | Returns an array of optional modules. Missing or invalid modules are non fatal
and will not harm the module itself.
an array of optional module specifications. |
| getProducer | | public String getProducer()(Code) | | Returns the name of the module producer.
the producer name |
| getRequiredModules | | public ModuleInfo[] getRequiredModules()(Code) | | Returns an array of all required modules. If one of these modules is missing
or cannot be initialized, the module itself will be not available.
an array of the required modules. |
| getSubSystem | | public String getSubSystem()(Code) | | Returns the modules subsystem. If this module is not part of an subsystem
then return the modules name, but never null.
the name of the subsystem. |
| initialize | | public void initialize(SubSystem subSystem) throws ModuleInitializeException(Code) | | Initializes the module. Use this method to perform all initial setup operations.
This method is called only once in a modules lifetime. If the initializing cannot
be completed, throw a ModuleInitializeException to indicate the error,. The module
will not be available to the system.
Parameters:
subSystem - the subSystem.
throws:
ModuleInitializeException - if an error ocurred while initializing the module. |
|
|