ConForM.CoopnTools.Formatter
Class FormatterEnv

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoopnEnv
        |
        +--ConForM.CoopnTools.Code.GenericCodeEnv
              |
              +--ConForM.CoopnTools.Formatter.FormatterEnv
All Implemented Interfaces:
java.lang.Cloneable

public class FormatterEnv
extends GenericCodeEnv

Formatter environment. Definition of environments dealing with the formatter tool.


Field Summary
 boolean contextMode
          Context mode.
 int format
          Format code.
 java.lang.String output
          Output file name.
 boolean tabMode
          Tabulator expand mode.
 int tabSize
          Tabulator size.
 
Fields inherited from class ConForM.CoopnTools.Code.GenericCodeEnv
compressionMode, kwFiles, moduleType, numberingMode, prettyMode, symbolMode, title
 
Fields inherited from class ConForM.CoopnTools.CoKer.CoopnEnv
cocoRead, cocoWrite, coopnHome, coopnLibs, debug, editor, err, in, locale, names, out, packageFile, project, queryHelp, queryVersion, queryXHelp, user, useThreads, verbose, warn
 
Constructor Summary
FormatterEnv(CoopnUser name)
          Simple constructor.
FormatterEnv(java.lang.String name)
          Simple constructor.
 
Method Summary
 java.lang.Object clone()
          Returns a clone environment.
 void copyFrom(FormatterEnv env)
          Copy the fields of an environment from another one.
 java.lang.String toString()
          String converion.
 
Methods inherited from class ConForM.CoopnTools.Code.GenericCodeEnv
copyFrom
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoopnEnv
copyFrom, user
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

format

public int format
Format code.
See Also:
FormatterEnvMgr

output

public java.lang.String output
Output file name. Specify the output file name. By default, takes the standard output file of the application.

contextMode

public boolean contextMode
Context mode. Context is added to the output file in this mode.

tabMode

public boolean tabMode
Tabulator expand mode. Tabulators are replaced by blanks in this mode.

tabSize

public int tabSize
Tabulator size.
Constructor Detail

FormatterEnv

public FormatterEnv(java.lang.String name)
Simple constructor.
Parameters:
name - the name of the tool

FormatterEnv

public FormatterEnv(CoopnUser name)
Simple constructor.
Parameters:
name - the user
Method Detail

toString

public java.lang.String toString()
String converion.
Overrides:
toString in class GenericCodeEnv

copyFrom

public void copyFrom(FormatterEnv env)
              throws CoopnEnvException
Copy the fields of an environment from another one. The user field is not affected.

clone

public java.lang.Object clone()
Returns a clone environment.
Overrides:
clone in class GenericCodeEnv