ConForM.CoopnTools.Formatter
Class Formatter

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

public class Formatter
extends java.lang.Object
implements CoopnTool

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

See Also:
run

Field Summary
static java.lang.String TOOL
          Formatter tool name.
static java.lang.String VERSION
          Formatter version.
 
Constructor Summary
protected Formatter(FormatterEnv env, FormatterEnvMgr envMgr)
          Simple constructor.
 
Method Summary
 CoopnEnv getEnv()
          Get the environment.
static Formatter getTool(CoopnEnv env)
          Creates a new checker, based on an existing environment, or null if the tool cannot be created.
static Formatter getTool(FormatterEnv env)
          Creates a new checker, 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
Formatter version.

TOOL

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

Formatter

protected Formatter(FormatterEnv env,
                    FormatterEnvMgr envMgr)
Simple constructor.
Parameters:
env - an environment manager containing a specific environment for the formatter
Method Detail

getTool

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

getTool

public static Formatter getTool(FormatterEnv env)
Creates a new checker, 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 checker according to the environment, and call its run method.