public interface ClassDoc extends ObjectDoc
Here the layout you may use:
getHeadingText() getDescription() getDiagramDocs() // loop and create figures getAttributesDoc() // if getAttributesDoc().notEmpty() then create table getAssociationEndsDoc() // if getAssociationEndsDoc().notEmpty() then create table getOperationsDoc() // if getOperationsDoc().notEmpty() then create table
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ANY_DA_OR_CDC_HEADING_FORMAT
(deprecated, abstract), alias, name
|
static java.lang.String |
CLASS_TITLE_PREFIX_FMT_CIM |
static java.lang.String |
CLASS_TITLE_PREFIX_FMT_IEC61850 |
static java.lang.String |
CONDITIONS_TEXT
Text to append to description if conditions need to be explicitly printed.
|
static java.lang.String |
LN_HEADING_FORMAT
(deprecated, abstract), alias, nbsp, name
|
static java.lang.String |
NO_ALIAS_HEADING_FORMAT
(deprecated, abstract), name, (kindLabel)
|
static java.lang.String |
OTHER_WITH_ALIAS_HEADING_FORMAT
(deprecated, abstract), alias, name, (stereotype)
|
static java.lang.String |
PRIM_DA_HEADING_FORMAT
(deprecated, abstract), alias, name, kindLabel
|
Modifier and Type | Method and Description |
---|---|
PropertiesDoc |
getAssocEndsDoc()
Returns the documentation for all the association ends on the 'other' side of this class,
suitable to be printed as a table.
|
PropertiesDoc |
getAttributesDoc()
Returns the documentation for all the attributes of this class, suitable to be printed as a
table.
|
java.lang.String |
getClassPlaceholderName()
Returns the qualified name of the class, with the separator appropriate for
placeholder.
|
java.util.List<FigureDoc> |
getDiagramDocs()
Returns the documentation for all the diagrams of this class.
|
PropertiesDoc |
getOperationsDoc()
Returns the documentation for all the operations of this class, suitable to be printed as a
table.
|
getBmRegistry, getBookmarkID, getDescription, getDocgenCfg, getHeadingText
copyCell, copyNonEmptyCell, getCell, getCells, hasKey, putCell, putCellNonEmpty
static final java.lang.String CLASS_TITLE_PREFIX_FMT_CIM
static final java.lang.String CLASS_TITLE_PREFIX_FMT_IEC61850
static final java.lang.String NO_ALIAS_HEADING_FORMAT
static final java.lang.String LN_HEADING_FORMAT
static final java.lang.String PRIM_DA_HEADING_FORMAT
static final java.lang.String ANY_DA_OR_CDC_HEADING_FORMAT
static final java.lang.String OTHER_WITH_ALIAS_HEADING_FORMAT
static final java.lang.String CONDITIONS_TEXT
java.lang.String getClassPlaceholderName()
PropertiesDoc getAttributesDoc()
PropertiesDoc.notEmpty()
to see whether there is anything to print.PropertiesDoc getAssocEndsDoc()
PropertiesDoc.notEmpty()
to see whether there
is anything to print.PropertiesDoc getOperationsDoc()
PropertiesDoc.notEmpty()
to see whether there is anything to print.java.util.List<FigureDoc> getDiagramDocs()
Copyright 2009-2016 Tatjana (Tanja) Kostic