Package com.structurizr.documentation
Class Documentation
java.lang.Object
com.structurizr.documentation.Documentation
public final class Documentation
extends java.lang.Object
Represents the documentation within a workspace - a collection of
content in Markdown or AsciiDoc format, optionally with attached images.
See Documentation
on the Structurizr website for more details.
-
Method Summary
Modifier and Type Method Description Decision
addDecision(SoftwareSystem softwareSystem, java.lang.String id, java.util.Date date, java.lang.String title, DecisionStatus status, Format format, java.lang.String content)
Adds a new decision to this workspace.Decision
addDecision(java.lang.String id, java.util.Date date, java.lang.String title, DecisionStatus status, Format format, java.lang.String content)
Adds a new decision to this workspace.void
clear()
Removes all documentation, decisions, and images.java.util.Set<Decision>
getDecisions()
Gets the set of decisions associated with this workspace.java.util.Set<Image>
getImages()
Gets the set ofImage
s in this workspace.java.util.Set<Section>
getSections()
Gets the set ofSection
s.TemplateMetadata
getTemplate()
Gets the template metadata associated with this documentation.boolean
isEmpty()
-
Method Details
-
getSections
Gets the set ofSection
s.- Returns:
- a Set of
Section
objects
-
getDecisions
Gets the set of decisions associated with this workspace.- Returns:
- a Set of Decision objects
-
addDecision
public Decision addDecision(java.lang.String id, java.util.Date date, java.lang.String title, DecisionStatus status, Format format, java.lang.String content)Adds a new decision to this workspace.- Parameters:
id
- the ID of the decisiondate
- the date of the decisiontitle
- the title of the decisionstatus
- the status of the decisionformat
- the format of the decision contentcontent
- the content of the decision- Returns:
- a Decision object
-
addDecision
public Decision addDecision(SoftwareSystem softwareSystem, java.lang.String id, java.util.Date date, java.lang.String title, DecisionStatus status, Format format, java.lang.String content)Adds a new decision to this workspace.- Parameters:
softwareSystem
- the SoftwareSystem to associate the decision withid
- the ID of the decisiondate
- the date of the decisiontitle
- the title of the decisionstatus
- the status of the decisionformat
- the format of the decision contentcontent
- the content of the decision- Returns:
- a Decision object
-
getImages
Gets the set ofImage
s in this workspace.- Returns:
- a Set of
Image
objects
-
isEmpty
public boolean isEmpty() -
clear
public void clear()Removes all documentation, decisions, and images. -
getTemplate
Gets the template metadata associated with this documentation.- Returns:
- a TemplateMetadata object, or null if there is none
-