Package com.structurizr.documentation
Class ViewpointsAndPerspectivesDocumentationTemplate
java.lang.Object
com.structurizr.documentation.DocumentationTemplate
com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate
public class ViewpointsAndPerspectivesDocumentationTemplate extends DocumentationTemplate
An implementation of the "Viewpoints and Perspectives" documentation template, from the "Software Systems Architecture" book by Nick Rozanski and Eoin Woods, consisting of the following sections:
- Introduction (1)
- Glossary (1)
- System Stakeholders and Requirements (2)
- Architectural Forces (2)
- Architectural Views (3)
- System Qualities (4)
- Appendices (5)
The number in parentheses () represents the grouping, which is simply used to colour code section navigation buttons when rendered.
-
Constructor Summary
Constructors Constructor Description ViewpointsAndPerspectivesDocumentationTemplate(Workspace workspace)
-
Method Summary
Modifier and Type Method Description Section
addAppendicesSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds an "Appendices" section relating to aSoftwareSystem
.Section
addAppendicesSection(SoftwareSystem softwareSystem, java.io.File... files)
Adds an "Appendices" section relating to aSoftwareSystem
from one or more files.Section
addArchitecturalForcesSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds an "Architectural Forces" section relating to aSoftwareSystem
.Section
addArchitecturalForcesSection(SoftwareSystem softwareSystem, java.io.File... files)
Adds an "Architectural Forces" section relating to aSoftwareSystem
from one or more files.Section
addArchitecturalViewsSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds an "Architectural Views" section relating to aSoftwareSystem
.Section
addArchitecturalViewsSection(SoftwareSystem softwareSystem, java.io.File... files)
Adds an "Architectural Views" section relating to aSoftwareSystem
from one or more files.Section
addGlossarySection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds a "Glossary" section relating to aSoftwareSystem
.Section
addGlossarySection(SoftwareSystem softwareSystem, java.io.File... files)
Adds a "Glossary" section relating to aSoftwareSystem
from one or more files.Section
addIntroductionSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds a "Introduction" section relating to aSoftwareSystem
.Section
addIntroductionSection(SoftwareSystem softwareSystem, java.io.File... files)
Adds a "Introduction" section relating to aSoftwareSystem
from one or more files.Section
addSystemQualitiesSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds a "System Qualities" section relating to aSoftwareSystem
.Section
addSystemQualitiesSection(SoftwareSystem softwareSystem, java.io.File... files)
Adds a "System Qualities" section relating to aSoftwareSystem
from one or more files.Section
addSystemStakeholdersAndRequirementsSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)
Adds a "System Stakeholders and Requirements" section relating to aSoftwareSystem
.Section
addSystemStakeholdersAndRequirementsSection(SoftwareSystem softwareSystem, java.io.File... files)
Adds a "System Stakeholders and Requirements" section relating to aSoftwareSystem
from one or more files.protected TemplateMetadata
getMetadata()
Gets the metadata associated with this template.Methods inherited from class com.structurizr.documentation.DocumentationTemplate
addImage, addImages, addSection, addSection, addSection, addSection, addSection, addSection, addSection, addSection
-
Constructor Details
-
Method Details
-
addIntroductionSection
public Section addIntroductionSection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds a "Introduction" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addIntroductionSection
public Section addIntroductionSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds a "Introduction" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
addGlossarySection
public Section addGlossarySection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds a "Glossary" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addGlossarySection
public Section addGlossarySection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds a "Glossary" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
addSystemStakeholdersAndRequirementsSection
public Section addSystemStakeholdersAndRequirementsSection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds a "System Stakeholders and Requirements" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addSystemStakeholdersAndRequirementsSection
public Section addSystemStakeholdersAndRequirementsSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds a "System Stakeholders and Requirements" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
addArchitecturalForcesSection
public Section addArchitecturalForcesSection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds an "Architectural Forces" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addArchitecturalForcesSection
public Section addArchitecturalForcesSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds an "Architectural Forces" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
addArchitecturalViewsSection
public Section addArchitecturalViewsSection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds an "Architectural Views" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addArchitecturalViewsSection
public Section addArchitecturalViewsSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds an "Architectural Views" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
addSystemQualitiesSection
public Section addSystemQualitiesSection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds a "System Qualities" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addSystemQualitiesSection
public Section addSystemQualitiesSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds a "System Qualities" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
addAppendicesSection
public Section addAppendicesSection(SoftwareSystem softwareSystem, java.io.File... files) throws java.io.IOExceptionAdds an "Appendices" section relating to aSoftwareSystem
from one or more files.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates tofiles
- one or more File objects that point to the documentation content- Returns:
- a documentation
Section
- Throws:
java.io.IOException
- if there is an error reading the files
-
addAppendicesSection
public Section addAppendicesSection(SoftwareSystem softwareSystem, Format format, java.lang.String content)Adds an "Appendices" section relating to aSoftwareSystem
.- Parameters:
softwareSystem
- theSoftwareSystem
the documentation content relates toformat
- theFormat
of the documentation contentcontent
- a String containing the documentation content- Returns:
- a documentation
Section
-
getMetadata
Description copied from class:DocumentationTemplate
Gets the metadata associated with this template.- Specified by:
getMetadata
in classDocumentationTemplate
- Returns:
- a TemplateMetadata object, or null if there is none
-