public class WordWriterInput extends WriterInput
Modifier and Type | Field and Description |
---|---|
private boolean |
_deep |
private ModelFinder |
_finder |
private java.lang.String |
_inTemplatePath |
private boolean |
_introToFigureBefore |
private java.lang.String |
_outFilePath |
private java.util.Map<java.lang.String,PackageDoc> |
_packageDocs |
private int |
_saveRecloseEvery |
private boolean |
_useBinaryDoc |
Modifier | Constructor and Description |
---|---|
|
WordWriterInput(Config cfg,
FreeFormDocumentation freeFormDoc)
Constructor.
|
private |
WordWriterInput(Config cfg,
java.lang.String appVersion,
boolean skipTiming,
java.lang.String modelFileName,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
ModelFinder finder,
java.lang.String inTemplatePath,
java.lang.String outFilePath,
boolean useBinaryDoc,
boolean introToFigureBefore,
int saveRecloseEvery,
boolean isDeep) |
|
WordWriterInput(java.lang.String appVersion,
java.lang.String modelFileName,
boolean skipTiming,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
ModelFinder finder,
java.lang.String inTemplatePath,
java.lang.String outFilePath,
boolean useBinaryDoc,
boolean introToFigureBefore,
int saveRecloseEvery,
boolean isDeep)
Constructor, useful to create an instance if you don't have configuration.
|
Modifier and Type | Method and Description |
---|---|
ModelFinder |
getFinder()
Returns object that can find in the UML model items specified in placeholders.
|
java.lang.String |
getInTemplatePath()
Returns absolute path of the file used as template for documentation, empty string if
template is not used.
|
java.lang.String |
getOutFilePath()
Returns absolute path of the file to which to write documentation.
|
java.util.Map<java.lang.String,PackageDoc> |
getPackageDocs()
Returns "flattened" map of package documentation instances, with package name as key (to
allow to quickly find the package name from what is read in the placeholder).
|
int |
getSaveRecloseEvery()
Returns the number of tables (captions) to print before closing and reopening the file; this
is an optimisation option that may not be applicable to all writers.
|
boolean |
isDeep()
Returns whether to write content for UML packages.
|
boolean |
isIntroToFigureBefore()
Returns whether to force figure introduction sentence before the figure.
|
boolean |
isUseBinaryDoc()
Returns whether to force use of COM API (binary .doc format).
|
getAppVersion, getModelFileName, getNameFromModelPath, isSkipTiming
private final java.util.Map<java.lang.String,PackageDoc> _packageDocs
private final ModelFinder _finder
private final java.lang.String _inTemplatePath
private final java.lang.String _outFilePath
private final boolean _useBinaryDoc
private final boolean _introToFigureBefore
private final int _saveRecloseEvery
private final boolean _deep
public WordWriterInput(Config cfg, FreeFormDocumentation freeFormDoc)
cfg
- freeFormDoc
- "flattened" map of package documentation instances, with package name as key (to
allow to quickly find the package name from what is read in the placeholder). If
null or empty, placeholders dealing with packages will all have error and empty
content.public WordWriterInput(java.lang.String appVersion, java.lang.String modelFileName, boolean skipTiming, java.util.Map<java.lang.String,PackageDoc> packageDocs, ModelFinder finder, java.lang.String inTemplatePath, java.lang.String outFilePath, boolean useBinaryDoc, boolean introToFigureBefore, int saveRecloseEvery, boolean isDeep)
appVersion
- modelFileName
- skipTiming
- packageDocs
- "flattened" map of package documentation instances, with package name as key (to
allow to quickly find the package name from what is read in the placeholder). If
null or empty, placeholders dealing with packages will all have error and empty
content.finder
- model facade; if null, most of placeholders will have error.inTemplatePath
- outFilePath
- useBinaryDoc
- introToFigureBefore
- saveRecloseEvery
- isDeep
- private WordWriterInput(Config cfg, java.lang.String appVersion, boolean skipTiming, java.lang.String modelFileName, java.util.Map<java.lang.String,PackageDoc> packageDocs, ModelFinder finder, java.lang.String inTemplatePath, java.lang.String outFilePath, boolean useBinaryDoc, boolean introToFigureBefore, int saveRecloseEvery, boolean isDeep)
public final java.util.Map<java.lang.String,PackageDoc> getPackageDocs()
public ModelFinder getFinder()
public java.lang.String getInTemplatePath()
public java.lang.String getOutFilePath()
public boolean isUseBinaryDoc()
public boolean isIntroToFigureBefore()
public int getSaveRecloseEvery()
public boolean isDeep()
Copyright 2009-2015 Tatjana (Tanja) Kostic