Index (structurizr-documentation 1.0.1 API)

A C D E F I R S U V
All Classes All Packages

A

addAppendicesSection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Appendices" section relating to a SoftwareSystem.
addAppendicesSection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Appendices" section relating to a SoftwareSystem from one or more files.
addArchitecturalDecisionsSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds an "Architectural Decisions" section.
addArchitecturalDecisionsSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds an "Architectural Decisions" section from one or more files.
addArchitecturalForcesSection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Forces" section relating to a SoftwareSystem.
addArchitecturalForcesSection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Forces" section relating to a SoftwareSystem from one or more files.
addArchitecturalViewsSection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Views" section relating to a SoftwareSystem.
addArchitecturalViewsSection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Views" section relating to a SoftwareSystem from one or more files.
addBuildingBlockViewSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Building Block View" section.
addBuildingBlockViewSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Building Block View" section from one or more files.
addCodeSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Code" section relating to a Component.
addCodeSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Code" section relating to a Component from one or more files.
addComponentsSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Components" section relating to a Container.
addComponentsSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Components" section relating to a Container from one or more files.
addConstraintsSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Constraints" section.
addConstraintsSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Constraints" section relating to a SoftwareSystem.
addConstraintsSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Constraints" section from one or more files.
addConstraintsSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Constraints" section relating to a SoftwareSystem from one or more files.
addContainersSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Containers" section relating to a SoftwareSystem.
addContainersSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Containers" section relating to a SoftwareSystem from one or more files.
addContextAndScopeSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Context and Scope" section.
addContextAndScopeSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Context and Scope" section from one or more files.
addContextSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Context" section relating to a SoftwareSystem.
addContextSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Context" section relating to a SoftwareSystem from one or more files.
addCrosscuttingConceptsSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Crosscutting Concepts" section.
addCrosscuttingConceptsSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Crosscutting Concepts" section from one or more files.
addDataSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Data" section relating to a SoftwareSystem.
addDataSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Data" section relating to a SoftwareSystem from one or more files.
addDecisionLogSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Decision Log" section relating to a SoftwareSystem.
addDecisionLogSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Decision Log" section relating to a SoftwareSystem from one or more files.
addDeploymentSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Deployment" section relating to a SoftwareSystem.
addDeploymentSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Deployment" section relating to a SoftwareSystem from one or more files.
addDeploymentViewSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Deployment View" section.
addDeploymentViewSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Deployment View" section from one or more files.
addDevelopmentEnvironmentSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Development Environment" section relating to a SoftwareSystem.
addDevelopmentEnvironmentSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Development Environment" section relating to a SoftwareSystem from one or more files.
addFunctionalOverviewSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Functional Overview" section relating to a SoftwareSystem.
addFunctionalOverviewSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Functional Overview" section relating to a SoftwareSystem from one or more files.
addGlossarySection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Glossary" section.
addGlossarySection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Glossary" section relating to a SoftwareSystem.
addGlossarySection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Glossary" section from one or more files.
addGlossarySection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Glossary" section relating to a SoftwareSystem from one or more files.
addInfrastructureArchitectureSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds an "Infrastructure Architecture" section relating to a SoftwareSystem.
addInfrastructureArchitectureSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds an "Infrastructure Architecture" section relating to a SoftwareSystem from one or more files.
addIntroductionAndGoalsSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds an "Introduction and Goals" section.
addIntroductionAndGoalsSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds an "Introduction and Goals" section from one or more files.
addIntroductionSection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Introduction" section relating to a SoftwareSystem.
addIntroductionSection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Introduction" section relating to a SoftwareSystem from one or more files.
addOperationAndSupportSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Operation and Support" section relating to a SoftwareSystem.
addOperationAndSupportSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds an "Operation and Support" section relating to a SoftwareSystem from one or more files.
addPrinciplesSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Principles" section relating to a SoftwareSystem.
addPrinciplesSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Principles" section relating to a SoftwareSystem from one or more files.
addQualityAttributesSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Quality Attributes" section relating to a SoftwareSystem.
addQualityAttributesSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Quality Attributes" section relating to a SoftwareSystem from one or more files.
addQualityRequirementsSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Quality Requirements" section.
addQualityRequirementsSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Quality Requirements" section from one or more files.
addRisksAndTechnicalDebtSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Risks and Technical Debt" section.
addRisksAndTechnicalDebtSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Risks and Technical Debt" section from one or more files.
addRuntimeViewSection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Runtime View" section.
addRuntimeViewSection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Runtime View" section from one or more files.
addSection(String, Format, String) - Method in class com.structurizr.documentation.template.DocumentationTemplate: Adds a documentation section.
addSection(String, File...) - Method in class com.structurizr.documentation.template.DocumentationTemplate: Adds a custom section from one or more files, that isn't related to any element in the model.
addSoftwareArchitectureSection(Format, String) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Software Architecture" section relating to a SoftwareSystem.
addSoftwareArchitectureSection(File...) - Method in class com.structurizr.documentation.template.StructurizrDocumentationTemplate: Adds a "Software Architecture" section relating to a SoftwareSystem from one or more files.
addSolutionStrategySection(Format, String) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Solution Strategy" section.
addSolutionStrategySection(File...) - Method in class com.structurizr.documentation.template.Arc42DocumentationTemplate: Adds a "Solution Strategy" section from one or more files.
addSystemQualitiesSection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Qualities" section relating to a SoftwareSystem.
addSystemQualitiesSection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Qualities" section relating to a SoftwareSystem from one or more files.
addSystemStakeholdersAndRequirementsSection(Format, String) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem.
addSystemStakeholdersAndRequirementsSection(File...) - Method in class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem from one or more files.
AdrToolsDecisionImporter - Class in com.structurizr.documentation.importer: Imports architecture decision records created/managed by adr-tools (https://github.com/npryce/adr-tools).
AdrToolsDecisionImporter() - Constructor for class com.structurizr.documentation.importer.AdrToolsDecisionImporter
Arc42DocumentationTemplate - Class in com.structurizr.documentation.template: An implementation of the arc42 documentation template, consisting of the following sections:
Arc42DocumentationTemplate(Documentable) - Constructor for class com.structurizr.documentation.template.Arc42DocumentationTemplate

C

calculateUrl(Decision) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter
com.structurizr.documentation.importer - package com.structurizr.documentation.importer
com.structurizr.documentation.template - package com.structurizr.documentation.template
com.structurizr.documentation.util - package com.structurizr.documentation.util

D

DefaultDocumentationImporter - Class in com.structurizr.documentation.importer: This implementation scans a given directory and automatically imports all Markdown or AsciiDoc files in that directory.
DefaultDocumentationImporter() - Constructor for class com.structurizr.documentation.importer.DefaultDocumentationImporter
DefaultImageImporter - Class in com.structurizr.documentation.importer: This implementation scans a given directory and automatically imports all Markdown or AsciiDoc files in that directory.
DefaultImageImporter() - Constructor for class com.structurizr.documentation.importer.DefaultImageImporter
documentation - Variable in class com.structurizr.documentation.template.DocumentationTemplate
DocumentationImporter - Interface in com.structurizr.documentation.importer: An interface implemented by documentation importers.
DocumentationImportException - Exception in com.structurizr.documentation.importer
DocumentationImportException(String, Throwable) - Constructor for exception com.structurizr.documentation.importer.DocumentationImportException
DocumentationImportException(Throwable) - Constructor for exception com.structurizr.documentation.importer.DocumentationImportException
DocumentationTemplate - Class in com.structurizr.documentation.template: A superclass for documentation templates.
DocumentationTemplate(Documentable) - Constructor for class com.structurizr.documentation.template.DocumentationTemplate: Creates a new documentation template for the given workspace or software system.

E

extractDate(String[]) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter
extractIntegerIDFromFileName(File) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter
extractLinks(Decision, Map<String, Decision>) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter
extractStatus(String[]) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter
extractTitle(String[]) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter

F

findFormat(File) - Static method in class com.structurizr.documentation.util.FormatFinder
FormatFinder - Class in com.structurizr.documentation.util
FormatFinder() - Constructor for class com.structurizr.documentation.util.FormatFinder

I

importDecision(File) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter
importDocumentation(Documentable, File) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter: Imports Markdown files from the specified path, one per decision.
importDocumentation(Documentable, File) - Method in class com.structurizr.documentation.importer.DefaultDocumentationImporter: Imports Markdown/AsciiDoc files from the specified path, each in its own section.
importDocumentation(Documentable, File) - Method in class com.structurizr.documentation.importer.DefaultImageImporter: Imports one or more png/jpg/jpeg/gif images from the specified path.
importDocumentation(Documentable, File) - Method in interface com.structurizr.documentation.importer.DocumentationImporter: Imports documentation from the specified path.
importDocumentation(Documentable, File) - Method in class com.structurizr.documentation.importer.RecursiveDefaultDocumentationImporter: Imports Markdown/AsciiDoc files from the specified path, each in its own section.
importFile(Documentable, File) - Method in class com.structurizr.documentation.importer.DefaultDocumentationImporter
isMarkdownOrAsciiDoc(File) - Static method in class com.structurizr.documentation.util.FormatFinder

R

readFiles(File...) - Method in class com.structurizr.documentation.template.DocumentationTemplate
RecursiveDefaultDocumentationImporter - Class in com.structurizr.documentation.importer: This implementation extends the DefaultDocumentationImporter to recursively import documentation.
RecursiveDefaultDocumentationImporter() - Constructor for class com.structurizr.documentation.importer.RecursiveDefaultDocumentationImporter

S

setDateFormat(String) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter: Sets the date format to use when parsing dates (the default is "yyyy-MM-dd").
setTimeZone(String) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter: Sets the time zone to use when parsing dates (the default is UTC)
setTimeZone(TimeZone) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter: Sets the time zone to use when parsing dates.
StructurizrDocumentationTemplate - Class in com.structurizr.documentation.template: A simple documentation template, based upon the "software guidebook" concept in Simon Brown's Software Architecture for Developers book, with the following sections:
StructurizrDocumentationTemplate(Documentable) - Constructor for class com.structurizr.documentation.template.StructurizrDocumentationTemplate

U

urlEncode(String) - Method in class com.structurizr.documentation.importer.AdrToolsDecisionImporter

V

ViewpointsAndPerspectivesDocumentationTemplate - Class in com.structurizr.documentation.template: 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:
ViewpointsAndPerspectivesDocumentationTemplate(Documentable) - Constructor for class com.structurizr.documentation.template.ViewpointsAndPerspectivesDocumentationTemplate

A C D E F I R S U V
All Classes All Packages