All Classes
| Class | Description |
|---|---|
| AbstractImpliedRelationshipsStrategy |
Abstract base class for supplied ImpliedRelationshipsStrategy implementations.
|
| AbstractWorkspace |
The superclass for regular and encrypted workspaces.
|
| Animation |
A wrapper for a collection of animation steps.
|
| Arc42DocumentationTemplate |
An implementation of the arc42 documentation template,
consisting of the following sections:
|
| AutomaticDocumentationTemplate |
This template allows you to scan a given directory and automatically add all Markdown or AsciiDoc
files in that directory.
|
| AutomaticLayout |
A wrapper for automatic layout configuration.
|
| AutomaticLayout.Implementation | |
| AutomaticLayout.RankDirection | |
| Border | |
| Branding |
A wrapper for the font, logo and color scheme associated with a corporate branding.
|
| CodeElement |
Represents a code element, such as a Java class or interface,
that is part of the implementation of a component.
|
| CodeElementRole |
Used to represent the role of a code element.
|
| Color | |
| ColorPair |
Represents a pair of colours: background and foreground.
|
| Component |
Represents a "component" in the C4 model.
|
| ComponentView |
Represents a Component view from the C4 model, showing the components within a given container.
|
| Configuration |
Configuration associated with how information in the workspace is rendered.
|
| Container |
Represents a "container" in the C4 model.
|
| ContainerInstance |
Represents a deployment instance of a
Container, which can be added to a DeploymentNode. |
| ContainerView |
Represents a Container view from the C4 model, showing the containers within a given software system.
|
| CreateImpliedRelationshipsUnlessAnyRelationshipExistsStrategy |
This strategy creates implied relationships between all valid combinations of the parent elements,
unless any relationship already exists between them.
|
| CreateImpliedRelationshipsUnlessSameRelationshipExistsStrategy |
This strategy creates implied relationships between all valid combinations of the parent elements,
unless the same relationship already exists between them.
|
| CustomElement |
Represents a custom element.
|
| CustomView |
Represents a custom view, containing custom elements.
|
| Decision |
Represents a single (architecture) decision, as described at http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
|
| DecisionStatus |
Represents the status of a decision.
|
| DefaultImpliedRelationshipsStrategy |
The default strategy is to NOT create implied relationships.
|
| DefaultLayoutMergeStrategy |
A default implementation of a LayoutMergeStrategy that:
- Sets the paper size (if not set).
|
| DeploymentElement |
This is the superclass for model elements that describe deployment nodes, infrastructure nodes, and container instances.
|
| DeploymentNode |
Represents a deployment node, which is something like:
|
| DeploymentView |
A deployment view, used to show the mapping of container instances to deployment nodes.
|
| Dimensions | |
| Documentation |
Represents the documentation within a workspace - a collection of
content in Markdown or AsciiDoc format, optionally with attached images.
|
| DocumentationTemplate |
The superclass for all documentation templates.
|
| DynamicView |
A dynamic view, used to describe behaviour between static elements at runtime.
|
| Element |
This is the superclass for all model elements.
|
| ElementNotPermittedInViewException | |
| ElementStyle |
A definition of an element style.
|
| ElementView |
Represents an instance of an Element in a View.
|
| Enterprise |
Represents an "enterprise" (e.g.
|
| FilteredView |
Represents a view on top of a view, which can be used to include or exclude specific elements.
|
| FilterMode | |
| Font |
Represents a font, including a name and an optional URL for web fonts.
|
| Format | |
| GroupableElement |
Represents an element that can be included in a group.
|
| HttpHealthCheck |
Describes a HTTP based health check.
|
| IdGenerator |
The interface that ID generators, used when creating IDs for model elements/relationships, must implement.
|
| Image |
Represents a base64 encoded image (png/jpg/gif).
|
| ImageUtils |
Some utility methods for dealing with images.
|
| ImpliedRelationshipsStrategy |
Defines the interface for strategies to create implied relationships in the model,
after a relationship has been created.
|
| InfrastructureNode |
Represents an infrastructure node, which is something like:
|
| InteractionStyle |
Use
InteractionStyles on Relationships to make the difference between synchronous and asynchronous communication
visible. |
| LayoutMergeStrategy |
A pluggable strategy that can be used to copy layout information from one version of a view to another.
|
| Location |
Represents the location of an element with regards to a specific viewpoint.
|
| MapUtils | |
| MetadataSymbols |
The type of symbols to use when rendering metadata.
|
| Model |
Represents a software architecture model, into which all model elements are added.
|
| ModelItem |
The base class for elements and relationships.
|
| PaperSize |
These represent paper sizes in pixels at 300dpi.
|
| PaperSize.Orientation | |
| Person |
Represents a "person" in the C4 model.
|
| Perspective |
Represents an architectural perspective, that can be applied to elements and relationships.
|
| Relationship |
A relationship between two elements.
|
| RelationshipStyle | |
| RelationshipView |
This class represents an instance of a Relationship on a View.
|
| Role |
Represents the access that a user has to a workspace.
|
| Routing | |
| Section |
A documentation section.
|
| SequentialIntegerIdGeneratorStrategy |
An ID generator that simply uses a sequential number when generating IDs for model elements and relationships.
|
| Shape | |
| SoftwareSystem |
Represents a "software system" in the C4 model.
|
| SoftwareSystemInstance |
Represents a deployment instance of a
SoftwareSystem, which can be added to a DeploymentNode. |
| StaticStructureElement |
This is the superclass for model elements that describe the static structure
of a software system, namely Person, SoftwareSystem, Container and Component.
|
| StaticStructureElementInstance |
Represents a deployment instance of a
SoftwareSystem or Container, which can be added to a DeploymentNode. |
| StaticView |
The superclass for all static views (system landscape, system context, container and component views).
|
| StringUtils | |
| StructurizrDocumentationTemplate |
A simple documentation template, based upon the "software guidebook" concept in Simon Brown's
Software Architecture for Developers
book, with the following sections:
|
| Styles | |
| SystemContextView |
Represents the System Context view from the C4 model, showing how a software system fits into its environment,
in terms of the users (people) and other software system dependencies.
|
| SystemLandscapeView |
Represents a System Landscape view that sits "above" the C4 model,
showing the software systems and people in a given environment.
|
| Tags | |
| TemplateMetadata |
Represents some basic metadata about the documentation template being used.
|
| Terminology |
Provides a way for the terminology on diagrams, etc to be modified (e.g.
|
| Url |
Utilities for dealing with URLs.
|
| User |
Represents a user, and the role-based access they have to a workspace.
|
| Vertex |
The X, Y coordinate of a bend in a line.
|
| View |
The superclass for all views (static views, dynamic views and deployment views).
|
| ViewpointsAndPerspectivesDocumentationTemplate |
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:
|
| ViewSet |
A set of views onto a software architecture model.
|
| ViewSortOrder |
Allows the sort order of views to be customized as follows:
|
| Workspace |
Represents a Structurizr workspace, which is a wrapper for a
software architecture model, views and documentation.
|
| WorkspaceConfiguration |
A wrapper for configuration options related to the workspace.
|
| WorkspaceValidationException |