public class FreeFormDocumentation
extends java.lang.Object
Constructor and Description |
---|
FreeFormDocumentation(ModelFinder modelFinder,
BookmarkRegistry bmRegistry,
java.util.Map<java.lang.String,PackageDoc> packageDocs,
java.util.Map<java.lang.String,ClassDoc> classDocs)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
BookmarkRegistry |
getBmRegistry() |
ClassDoc |
getClassDoc(java.lang.String qName) |
java.util.Map<java.lang.String,ClassDoc> |
getClassDocs() |
ModelFinder |
getModelFinder() |
PackageDoc |
getPackageDoc(java.lang.String name) |
java.util.Map<java.lang.String,PackageDoc> |
getPackageDocs() |
public FreeFormDocumentation(ModelFinder modelFinder, BookmarkRegistry bmRegistry, java.util.Map<java.lang.String,PackageDoc> packageDocs, java.util.Map<java.lang.String,ClassDoc> classDocs)
modelFinder
- model facade; if null, most of placeholders will have error.bmRegistry
- registry of bookmarks, i.e., contains maps between bookmark IDs (unique strings)
and UML objects; can be used for generating hyperlinks.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
- "flattened" map of class documentation instances, with qualified class 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 classes will all have
error and empty content.public ModelFinder getModelFinder()
public BookmarkRegistry getBmRegistry()
public java.util.Map<java.lang.String,PackageDoc> getPackageDocs()
public PackageDoc getPackageDoc(java.lang.String name)
public java.util.Map<java.lang.String,ClassDoc> getClassDocs()
public ClassDoc getClassDoc(java.lang.String qName)
Copyright 2009-2016 Tatjana (Tanja) Kostic