public class DocCollectorImpl extends java.lang.Object implements DocCollector
DocCollector
,.Constructor and Description |
---|
DocCollectorImpl(Config cfg,
ModelFinder modelFinder)
Constructs the instance to manually (through API) add documentation for package and other UML
objects.
|
DocCollectorImpl(UmlModel model)
Constructs the collector from the UML model.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addSkippedInformativePackage(java.lang.String qName)
Must be called by every newly created
PackageDoc that is to be skipped. |
void |
addToFlattened(ClassDoc classDoc)
Must be called for every newly created
ClassDoc that need not be skipped. |
void |
addToFlattened(PackageDoc packageDoc)
Must be called for every newly created
PackageDoc that need not be skipped. |
void |
addToScoped(PackageDoc packageDoc)
Must be called by every newly created
PackageDoc that need not be skipped, if
owner is in scope and it needs to be included in the name space: adds the
packageDoc under appropriate nature and name space, no-op otherwise. |
void |
collect(UmlModel model)
Collects recursively documentation from UML model packages, their sub-packages, etc.
|
BookmarkRegistry |
getBmRegistry()
Returns bookmark registry populated from the UML model.
|
DocgenConfig |
getDocgenCfg()
Returns configuration according to which the documentation is collected for generation.
|
FixedFormDocumentation |
getFixedFormDocumentation()
Creates if not yet called and then returns documentation per package, indexed by nature.
|
FreeFormDocumentation |
getFreeFormDocumentation()
Creates if not yet called and then returns documentation per package, indexed by package name
for easy reference; if there were any two packages with the same name, retains only the first
one collected.
|
boolean |
isFromUml()
Returns whether this collector has been created from a UML model (as opposed to pure API
calls).
|
java.lang.String |
toString() |
public DocCollectorImpl(UmlModel model)
collect(UmlModel)
to obtain the input for document generation.model
- public DocCollectorImpl(Config cfg, ModelFinder modelFinder)
cfg
- modelFinder
- public void collect(UmlModel model)
DocCollector
collect
in interface DocCollector
model
- UML model.public FreeFormDocumentation getFreeFormDocumentation()
DocCollector
getFreeFormDocumentation
in interface DocCollector
public FixedFormDocumentation getFixedFormDocumentation()
DocCollector
getFixedFormDocumentation
in interface DocCollector
public void addToFlattened(PackageDoc packageDoc)
DocCollector
PackageDoc
that need not be skipped.addToFlattened
in interface DocCollector
packageDoc
- package documentation to retain.public void addToFlattened(ClassDoc classDoc)
DocCollector
ClassDoc
that need not be skipped.addToFlattened
in interface DocCollector
classDoc
- class documentation to retain.public void addToScoped(PackageDoc packageDoc)
DocCollector
PackageDoc
that need not be skipped, if
owner
is in scope and it needs to be included in the name space: adds the
packageDoc
under appropriate nature and name space, no-op otherwise.addToScoped
in interface DocCollector
public boolean addSkippedInformativePackage(java.lang.String qName)
DocCollector
PackageDoc
that is to be skipped. Returns
whether qName
has been added to the collection of skipped informative package
names. Because it is intended to be used for logging only, we don't need objects (strings are
enough).addSkippedInformativePackage
in interface DocCollector
qName
- qualified name of the package.public DocgenConfig getDocgenCfg()
DocCollector
getDocgenCfg
in interface DocCollector
public BookmarkRegistry getBmRegistry()
DocCollector
getBmRegistry
in interface DocCollector
public boolean isFromUml()
DocCollector
isFromUml
in interface DocCollector
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2009-2016 Tatjana (Tanja) Kostic