Save This Page
Home » jcommon-1.0.13 » org.jfree.base.modules » [javadoc | source]
org.jfree.base.modules
public interface: Module [javadoc | source]

All Implemented Interfaces:
    ModuleInfo

All Known Implementing Classes:
    DefaultLogModule, AbstractModule

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.

Method from org.jfree.base.modules.Module Summary:
configure,   getDescription,   getName,   getOptionalModules,   getProducer,   getRequiredModules,   getSubSystem,   initialize
Method from org.jfree.base.modules.Module Detail:
 public  void configure(SubSystem subSystem)
    Configures the module. This should load the default settings of the module.
 public String getDescription()
    Returns a short description of the modules functionality.
 public String getName()
    Returns the module name. This name should be a short descriptive handle of the module.
 public ModuleInfo[] getOptionalModules()
    Returns an array of optional modules. Missing or invalid modules are non fatal and will not harm the module itself.
 public String getProducer()
    Returns the name of the module producer.
 public ModuleInfo[] getRequiredModules()
    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.
 public String getSubSystem()
    Returns the modules subsystem. If this module is not part of an subsystem then return the modules name, but never null.
 public  void initialize(SubSystem subSystem) throws ModuleInitializeException
    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.