ConForM.CoopnTools.Doc
Class DocEnvMgr
java.lang.Object
|
+--ConForM.CoopnTools.CoKer.CoopnEnvMgr
|
+--ConForM.CoopnTools.Doc.DocEnvMgr
- public class DocEnvMgr
- extends CoopnEnvMgr
Documenter environment manager.
Constructor Summary |
DocEnvMgr(CoopnUser name)
Creates a new environment manager, along with a new environment. |
DocEnvMgr(DocEnv env)
Creates a new environment manager based on an existing environment. |
DocEnvMgr(java.lang.String name)
Creates a new environment manager, along with a new environment. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DocEnvMgr
public DocEnvMgr(java.lang.String name)
throws CoopnEnvException
- Creates a new environment manager, along with a new environment.
- Parameters:
name
- the tool name- Throws:
CoopnEnvException
- error during the creation of the manager.
In this case, the error
stream is appended with the descriptions of
the errors.
DocEnvMgr
public DocEnvMgr(CoopnUser name)
throws CoopnEnvException
- Creates a new environment manager, along with a new environment.
- Parameters:
name
- the user name- Throws:
CoopnEnvException
- error during the creation of the manager.
In this case, the error
stream is appended with the descriptions of
the errors.
DocEnvMgr
public DocEnvMgr(DocEnv env)
throws CoopnEnvException
- Creates a new environment manager based on an existing environment.
- Parameters:
env
- an environment used as the base of the new one- Throws:
CoopnEnvException
- error during the creation of the manager.
In this case, the error
stream is appended with the descriptions of
the errors.
createEnvFromName
protected CoopnEnv createEnvFromName(java.lang.String name)
- Overrides:
createEnvFromName
in class CoopnEnvMgr
createEnvFromUser
protected CoopnEnv createEnvFromUser(CoopnUser name)
- Overrides:
createEnvFromUser
in class CoopnEnvMgr
initCoopnTools
public void initCoopnTools(DocEnv env)
throws CoopnEnvException
- Initialise the environment of a CoopnTool.
The environment is completed from an existing one.
- Parameters:
env
- the existing environment- Throws:
CoopnEnvException
- one or more errors occured during the initialisation
of the environment. In this case, the error
stream is appended with the descriptions of
the errors.
updateEnv
protected boolean updateEnv(java.util.Map decodedOptions)
- Overrides:
updateEnv
in class CoopnEnvMgr