ConForM.CoopnTools.Module
Class Module

java.lang.Object
  |
  +--ConForM.CoopnTools.Module.Module
All Implemented Interfaces:
CoopnTool, java.lang.Runnable

public class Module
extends java.lang.Object
implements CoopnTool

CoopnTools expanded source viewer. The intension is to obtain textual representations of expanded source modules, with keywords in boldface, comments in light text, and so on. A formatter is a runnable. It is composed of a constructor, building the tool, by a method run, implementing the tool itself, and a method main. Hence, a code viewer can be started either from a command line, or by another CoopnTool. In this case, a listing viewer is likely to by started as a new thread.

See Also:
run

Field Summary
static java.lang.String TOOL
          Module tool name.
static java.lang.String VERSION
          Module version.
 
Constructor Summary
protected Module(ModuleEnv env, ModuleEnvMgr envMgr)
          Simple constructor.
 
Method Summary
 CoopnEnv getEnv()
          Get the environment.
static Module getTool(CoopnEnv env)
          Creates a new Module, based on an existing environment, or null if the tool cannot be created.
static Module getTool(ModuleEnv env)
          Creates a new Module, based on an existing environment, or null if the tool cannot be created.
static void main(java.lang.String[] args)
          Main program.
 void run()
          Implementation of the formatter.
 void show()
          Show the tool's window, if the tool has its own GUI.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION

public static final java.lang.String VERSION
Module version.

TOOL

public static final java.lang.String TOOL
Module tool name.
Constructor Detail

Module

protected Module(ModuleEnv env,
                 ModuleEnvMgr envMgr)
Simple constructor.
Parameters:
env - an environment manager containing a specific environment for the tool
Method Detail

getTool

public static Module getTool(CoopnEnv env)
Creates a new Module, based on an existing environment, or null if the tool cannot be created.

getTool

public static Module getTool(ModuleEnv env)
Creates a new Module, based on an existing environment, or null if the tool cannot be created.

getEnv

public CoopnEnv getEnv()
Get the environment.
Specified by:
getEnv in interface CoopnTool

show

public void show()
Show the tool's window, if the tool has its own GUI. Do nothing else.
Specified by:
show in interface CoopnTool

run

public void run()
Implementation of the formatter.
Specified by:
run in interface java.lang.Runnable

main

public static void main(java.lang.String[] args)
Main program. This method creates a new environment from the command line, creates a new Code according to the environment, and call its run method.