public class WordWriterInput extends WriterInput
Constructor and Description |
---|
WordWriterInput(Config cfg,
FreeFormDocumentation freeFormDoc)
Constructor.
|
WordWriterInput(java.lang.String appVersion,
java.lang.String modelFileName,
boolean skipTiming,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
java.util.Map<java.lang.String,ClassDoc> classDocs,
ModelFinder finder,
java.lang.String inTemplatePath,
java.lang.String outFilePath,
boolean useBinaryDoc,
boolean introToFigureBefore,
int saveRecloseEvery,
boolean isDeep,
boolean useHyperlinks,
BookmarkRegistry bmRegistry)
Constructor, useful to create an instance if you don't have configuration.
|
Modifier and Type | Method and Description |
---|---|
BookmarkRegistry |
getBookmarkRegistry()
Returns bookmarks registry (used for hyperlinks).
|
java.util.Map<java.lang.String,ClassDoc> |
getClassDocs()
Returns "flattened" map of class documentation instances, with qualified class name as
key (to allow to quickly find the class name from what is read in the placeholder).
|
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).
|
boolean |
isUseHyperlinks()
Returns whether to generate hyperlinks (for types of properties).
|
getAppVersion, getModelFileName, getNameFromModelPath, isSkipTiming
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, java.util.Map<java.lang.String,ClassDoc> classDocs, ModelFinder finder, java.lang.String inTemplatePath, java.lang.String outFilePath, boolean useBinaryDoc, boolean introToFigureBefore, int saveRecloseEvery, boolean isDeep, boolean useHyperlinks, BookmarkRegistry bmRegistry)
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.classDocs
- finder
- model facade; if null, most of placeholders will have error.inTemplatePath
- outFilePath
- useBinaryDoc
- introToFigureBefore
- saveRecloseEvery
- isDeep
- useHyperlinks
- bmRegistry
- public final java.util.Map<java.lang.String,PackageDoc> getPackageDocs()
public final java.util.Map<java.lang.String,ClassDoc> getClassDocs()
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()
public boolean isUseHyperlinks()
public BookmarkRegistry getBookmarkRegistry()
Copyright 2009-2016 Tatjana (Tanja) Kostic