Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.dghda.module
Class BaseModule  view BaseModule download BaseModule.java

java.lang.Object
  extended bycom.dghda.module.BaseModule
All Implemented Interfaces:
Module

public abstract class BaseModule
extends java.lang.Object
implements Module

A base implementation of a module.


Nested Class Summary
 
Nested classes inherited from class com.dghda.module.Module
Module.ModuleVersion
 
Field Summary
private  java.lang.String m_Description
           
private  java.lang.String m_ID
           
private  java.lang.String m_ShortName
           
private  Module.ModuleVersion m_Version
           
 
Constructor Summary
BaseModule(java.lang.String id, java.lang.String shortName, java.lang.String description, Module.ModuleVersion version)
          Create a new module.
 
Method Summary
 java.lang.String getDescription()
          Returns a description of the module.
 java.lang.String getID()
          Returns the module's ID.
 java.lang.String getName()
          Returns the name of the module.
 Module.ModuleVersion getVersion()
          Returns version information about the module.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_ID

private java.lang.String m_ID

m_ShortName

private java.lang.String m_ShortName

m_Description

private java.lang.String m_Description

m_Version

private Module.ModuleVersion m_Version
Constructor Detail

BaseModule

public BaseModule(java.lang.String id,
                  java.lang.String shortName,
                  java.lang.String description,
                  Module.ModuleVersion version)
Create a new module.

Method Detail

getID

public java.lang.String getID()
Returns the module's ID.

Specified by:
getID in interface Module

getName

public java.lang.String getName()
Returns the name of the module. This name should be suitable for display.

Specified by:
getName in interface Module

getVersion

public Module.ModuleVersion getVersion()
Returns version information about the module.

Specified by:
getVersion in interface Module

getDescription

public java.lang.String getDescription()
Returns a description of the module.

Specified by:
getDescription in interface Module