Index (structurizr-core 1.4.1 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages

A

A0_Landscape - com.structurizr.view.PaperSize
A0_Portrait - com.structurizr.view.PaperSize
A1_Landscape - com.structurizr.view.PaperSize
A1_Portrait - com.structurizr.view.PaperSize
A2_Landscape - com.structurizr.view.PaperSize
A2_Portrait - com.structurizr.view.PaperSize
A3_Landscape - com.structurizr.view.PaperSize
A3_Portrait - com.structurizr.view.PaperSize
A4_Landscape - com.structurizr.view.PaperSize
A4_Portrait - com.structurizr.view.PaperSize
A5_Landscape - com.structurizr.view.PaperSize
A5_Portrait - com.structurizr.view.PaperSize
A6_Landscape - com.structurizr.view.PaperSize
A6_Portrait - com.structurizr.view.PaperSize
AbstractImpliedRelationshipsStrategy - Class in com.structurizr.model: Abstract base class for supplied ImpliedRelationshipsStrategy implementations.
AbstractImpliedRelationshipsStrategy() - Constructor for class com.structurizr.model.AbstractImpliedRelationshipsStrategy
AbstractWorkspace - Class in com.structurizr: The superclass for regular and encrypted workspaces.
AbstractWorkspace() - Constructor for class com.structurizr.AbstractWorkspace
Accepted - com.structurizr.documentation.DecisionStatus
add(Component) - Method in class com.structurizr.view.ComponentView: Adds an individual component to this view, including relationships to/from that component.
add(Component, boolean) - Method in class com.structurizr.view.ComponentView: Adds an individual component to this view.
add(Container) - Method in class com.structurizr.model.DeploymentNode: Adds a container instance to this deployment node, replicating all of the container-container relationships.
add(Container) - Method in class com.structurizr.view.ComponentView: Adds an individual container to this view, including relationships to/from that container.
add(Container) - Method in class com.structurizr.view.ContainerView: Adds an individual container (belonging to any software system) to this view, including relationships to/from that container.
add(Container, boolean) - Method in class com.structurizr.model.DeploymentNode: Adds a container instance to this deployment node, optionally replicating all of the container-container relationships.
add(Container, boolean) - Method in class com.structurizr.view.ComponentView: Adds an individual container to this view.
add(Container, boolean) - Method in class com.structurizr.view.ContainerView: Adds an individual container (belonging to any software system) to this view.
add(DeploymentNode) - Method in class com.structurizr.view.DeploymentView: Adds a deployment node to this view, including relationships to/from that deployment node (and children).
add(DeploymentNode, boolean) - Method in class com.structurizr.view.DeploymentView: Adds a deployment node to this view.
add(Element, Element) - Method in class com.structurizr.view.DynamicView
add(Element, String, Element) - Method in class com.structurizr.view.DynamicView
add(Person) - Method in class com.structurizr.view.StaticView: Adds the given person to this view, including relationships to/from that person.
add(Person, boolean) - Method in class com.structurizr.view.StaticView: Adds the given person to this view.
add(Relationship) - Method in class com.structurizr.view.DeploymentView: Adds a Relationship to this view.
add(Relationship) - Method in class com.structurizr.view.StaticView: Adds a specific relationship to this view.
add(SoftwareSystem) - Method in class com.structurizr.view.ComponentView: Adds the specified software system, including relationships to/from that software system.
add(SoftwareSystem) - Method in class com.structurizr.view.ContainerView: Adds a software system to this view, including relationships to/from that software system.
add(SoftwareSystem) - Method in class com.structurizr.view.StaticView: Adds the given software system to this view, including relationships to/from that software system.
add(SoftwareSystem, boolean) - Method in class com.structurizr.view.ComponentView: Adds the specified software system.
add(SoftwareSystem, boolean) - Method in class com.structurizr.view.ContainerView: Adds a software system to this view.
add(SoftwareSystem, boolean) - Method in class com.structurizr.view.StaticView: Adds the given software system to this view.
add(ElementStyle) - Method in class com.structurizr.view.Styles
add(RelationshipStyle) - Method in class com.structurizr.view.Styles
addAllComponents() - Method in class com.structurizr.view.ComponentView: Adds all components in the container to this view.
addAllContainers() - Method in class com.structurizr.view.ComponentView: Adds all other containers in the software system to this view.
addAllContainers() - Method in class com.structurizr.view.ContainerView: Adds all containers within the software system in scope to this view.
addAllContainersAndInfluencers() - Method in class com.structurizr.view.ContainerView: Adds all Containers of the given ContainerView as well as all external influencers, that is all persons and all other software systems with incoming or outgoing dependencies.
addAllDeploymentNodes() - Method in class com.structurizr.view.DeploymentView: Adds all of the top-level deployment nodes to this view.
addAllElements() - Method in class com.structurizr.view.ComponentView: Adds all people, software systems, sibling containers and components belonging to the container in scope.
addAllElements() - Method in class com.structurizr.view.ContainerView: Adds all people, software systems and containers that belong to the software system in scope.
addAllElements() - Method in class com.structurizr.view.StaticView: Adds all of the permitted elements to this view.
addAllElements() - Method in class com.structurizr.view.SystemContextView: Adds all software systems and all people.
addAllElements() - Method in class com.structurizr.view.SystemLandscapeView: Adds all software systems and all people to this view.
addAllInfluencers() - Method in class com.structurizr.view.ContainerView: Adds all Containers of the given ContainerView as well as all external influencers, that is all persons and all other software systems with incoming or outgoing dependencies.
addAllPeople() - Method in class com.structurizr.view.StaticView: Adds all people in the model to this view.
addAllSoftwareSystems() - Method in class com.structurizr.view.StaticView: Adds all software systems in the model to this view.
addAnimation(ContainerInstance...) - Method in class com.structurizr.view.DeploymentView: Adds an animation step, with the specified container instances.
addAnimation(Element...) - Method in class com.structurizr.view.StaticView: Adds an animation step, with the specified elements.
addAnimation(InfrastructureNode...) - Method in class com.structurizr.view.DeploymentView: Adds an animation step, with the specified infrastructure nodes.
addAppendicesSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Appendices" section relating to a SoftwareSystem.
addAppendicesSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Appendices" section relating to a SoftwareSystem from one or more files.
addArchitecturalDecisionsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds an "Architectural Decisions" section relating to a SoftwareSystem.
addArchitecturalDecisionsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds an "Architectural Decisions" section relating to a SoftwareSystem from one or more files.
addArchitecturalForcesSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Forces" section relating to a SoftwareSystem.
addArchitecturalForcesSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Forces" section relating to a SoftwareSystem from one or more files.
addArchitecturalViewsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Views" section relating to a SoftwareSystem.
addArchitecturalViewsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds an "Architectural Views" section relating to a SoftwareSystem from one or more files.
addBuildingBlockViewSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Building Block View" section relating to a SoftwareSystem.
addBuildingBlockViewSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Building Block View" section relating to a SoftwareSystem from one or more files.
addCodeSection(Component, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Code" section relating to a Component.
addCodeSection(Component, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Code" section relating to a Component from one or more files.
addComponent(String, Class, String, String) - Method in class com.structurizr.model.Container: Adds a component to this container.
addComponent(String, String) - Method in class com.structurizr.model.Container: Adds a component to this container.
addComponent(String, String, String) - Method in class com.structurizr.model.Container: Adds a component to this container.
addComponent(String, String, String, String) - Method in class com.structurizr.model.Container: Adds a component to this container.
addComponentsSection(Container, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Components" section relating to a Container.
addComponentsSection(Container, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Components" section relating to a Container from one or more files.
addConstraintsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Constraints" section relating to a SoftwareSystem.
addConstraintsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Constraints" section relating to a SoftwareSystem.
addConstraintsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Constraints" section relating to a SoftwareSystem from one or more files.
addConstraintsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Constraints" section relating to a SoftwareSystem from one or more files.
addContainer(String, String, String) - Method in class com.structurizr.model.SoftwareSystem: Adds a container with the specified name, description and technology
addContainersSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Containers" section relating to a SoftwareSystem.
addContainersSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Containers" section relating to a SoftwareSystem from one or more files.
addContextAndScopeSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Context and Scope" section relating to a SoftwareSystem.
addContextAndScopeSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Context and Scope" section relating to a SoftwareSystem from one or more files.
addContextSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Context" section relating to a SoftwareSystem.
addContextSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Context" section relating to a SoftwareSystem from one or more files.
addCrosscuttingConceptsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Crosscutting Concepts" section relating to a SoftwareSystem.
addCrosscuttingConceptsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Crosscutting Concepts" section relating to a SoftwareSystem from one or more files.
addDataSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Data" section relating to a SoftwareSystem.
addDataSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Data" section relating to a SoftwareSystem from one or more files.
addDecision(SoftwareSystem, String, Date, String, DecisionStatus, Format, String) - Method in class com.structurizr.documentation.Documentation: Adds a new decision to this workspace.
addDecision(String, Date, String, DecisionStatus, Format, String) - Method in class com.structurizr.documentation.Documentation: Adds a new decision to this workspace.
addDecisionLogSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Decision Log" section relating to a SoftwareSystem.
addDecisionLogSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Decision Log" section relating to a SoftwareSystem from one or more files.
addDependentSoftwareSystems() - Method in class com.structurizr.view.ContainerView
addDeploymentNode(String) - Method in class com.structurizr.model.DeploymentNode: Adds a child deployment node.
addDeploymentNode(String) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentNode(String, String, String) - Method in class com.structurizr.model.DeploymentNode: Adds a child deployment node.
addDeploymentNode(String, String, String) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentNode(String, String, String, int) - Method in class com.structurizr.model.DeploymentNode: Adds a child deployment node.
addDeploymentNode(String, String, String, int) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentNode(String, String, String, int, Map<String, String>) - Method in class com.structurizr.model.DeploymentNode: Adds a child deployment node.
addDeploymentNode(String, String, String, int, Map<String, String>) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentNode(String, String, String, String) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentNode(String, String, String, String, int) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentNode(String, String, String, String, int, Map<String, String>) - Method in class com.structurizr.model.Model: Adds a top-level deployment node to this model.
addDeploymentSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Deployment" section relating to a SoftwareSystem.
addDeploymentSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Deployment" section relating to a SoftwareSystem from one or more files.
addDeploymentViewSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Deployment View" section relating to a SoftwareSystem.
addDeploymentViewSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Deployment View" section relating to a SoftwareSystem from one or more files.
addDevelopmentEnvironmentSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Development Environment" section relating to a SoftwareSystem.
addDevelopmentEnvironmentSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Development Environment" section relating to a SoftwareSystem from one or more files.
addElement(Element, boolean) - Method in class com.structurizr.view.View
addElementStyle(String) - Method in class com.structurizr.view.Styles
addExternalDependencies() - Method in class com.structurizr.view.ComponentView: Adds all Elements external to the container (Person, SoftwareSystem or Container) that have Relationships to or from Components in this view.
addFunctionalOverviewSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Functional Overview" section relating to a SoftwareSystem.
addFunctionalOverviewSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Functional Overview" section relating to a SoftwareSystem from one or more files.
addGlossarySection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Glossary" section relating to a SoftwareSystem.
addGlossarySection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Glossary" section relating to a SoftwareSystem.
addGlossarySection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Glossary" section relating to a SoftwareSystem from one or more files.
addGlossarySection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Glossary" section relating to a SoftwareSystem from one or more files.
addHeader(String, String) - Method in class com.structurizr.model.HttpHealthCheck: Adds a HTTP header, which will be sent with the HTTP request to the health check URL.
addHealthCheck(String, String) - Method in class com.structurizr.model.ContainerInstance: Adds a new health check, with the default interval (60 seconds) and timeout (0 milliseconds).
addHealthCheck(String, String, int, long) - Method in class com.structurizr.model.ContainerInstance: Adds a new health check.
addImage(File) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds an image from the given file to the workspace.
addImages(File) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds png/jpg/jpeg/gif images in the given directory to the workspace.
addImplicitRelationships() - Method in class com.structurizr.model.Model: Deprecated.
use Model.setImpliedRelationshipsStrategy(ImpliedRelationshipsStrategy) ()} instead to set a strategy, before creating relationships
addInfrastructureArchitectureSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Infrastructure Architecture" section relating to a SoftwareSystem.
addInfrastructureArchitectureSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds an "Infrastructure Architecture" section relating to a SoftwareSystem from one or more files.
addInfrastructureNode(String) - Method in class com.structurizr.model.DeploymentNode: Adds a child infrastructure node.
addInfrastructureNode(String, String, String) - Method in class com.structurizr.model.DeploymentNode: Adds a child infrastructure node.
addInfrastructureNode(String, String, String, Map<String, String>) - Method in class com.structurizr.model.DeploymentNode: Adds a child infrastructure node.
addIntroductionAndGoalsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Introduction and Goals" section relating to a SoftwareSystem.
addIntroductionAndGoalsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Introduction and Goals" section relating to a SoftwareSystem from one or more files.
addIntroductionSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Introduction" section relating to a SoftwareSystem.
addIntroductionSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "Introduction" section relating to a SoftwareSystem from one or more files.
addNearestNeighbours(Element) - Method in class com.structurizr.view.ComponentView: Adds all people, software systems, sibling containers and components that are directly connected to the specified element.
addNearestNeighbours(Element) - Method in class com.structurizr.view.ContainerView: Adds all people, software systems and containers that are directly connected to the specified element.
addNearestNeighbours(Element) - Method in class com.structurizr.view.StaticView: Adds all of the permitted elements, which are directly connected to the specified element, to this view.
addNearestNeighbours(Element) - Method in class com.structurizr.view.SystemContextView: Adds all software systems and people that are directly connected to the specified element.
addNearestNeighbours(Element) - Method in class com.structurizr.view.SystemLandscapeView: Adds all software systems and people that are directly connected to the specified element.
addNearestNeighbours(Element, Class<T>) - Method in class com.structurizr.view.StaticView
addOperationAndSupportSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Operation and Support" section relating to a SoftwareSystem.
addOperationAndSupportSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds an "Operation and Support" section relating to a SoftwareSystem from one or more files.
addPerson(Location, String, String) - Method in class com.structurizr.model.Model: Creates a person and adds it to the model.
addPerson(String, String) - Method in class com.structurizr.model.Model: Creates a person (with an unspecified location) and adds it to the model.
addPrinciplesSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Principles" section relating to a SoftwareSystem.
addPrinciplesSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Principles" section relating to a SoftwareSystem from one or more files.
addQualityAttributesSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Quality Attributes" section relating to a SoftwareSystem.
addQualityAttributesSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Quality Attributes" section relating to a SoftwareSystem from one or more files.
addQualityRequirementsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Quality Requirements" section relating to a SoftwareSystem.
addQualityRequirementsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Quality Requirements" section relating to a SoftwareSystem from one or more files.
addRelationship(Relationship) - Method in class com.structurizr.view.View
addRelationship(Relationship, String, String) - Method in class com.structurizr.view.View
addRelationshipStyle(String) - Method in class com.structurizr.view.Styles
addRisksAndTechnicalDebtSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Risks and Technical Debt" section relating to a SoftwareSystem.
addRisksAndTechnicalDebtSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Risks and Technical Debt" section relating to a SoftwareSystem from one or more files.
addRuntimeViewSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Runtime View" section relating to a SoftwareSystem.
addRuntimeViewSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Runtime View" section relating to a SoftwareSystem from one or more files.
addSection(Component, String, Format, String) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a section relating to a Component.
addSection(Component, String, File...) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a section relating to a Component from one or more files.
addSection(Container, String, Format, String) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a section relating to a Container.
addSection(Container, String, File...) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a section relating to a Container from one or more files.
addSection(SoftwareSystem, String, Format, String) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a section relating to a SoftwareSystem.
addSection(SoftwareSystem, String, File...) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a section relating to a SoftwareSystem from one or more files.
addSection(String, Format, String) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a custom section, that isn't related to any element in the model.
addSection(String, File...) - Method in class com.structurizr.documentation.DocumentationTemplate: Adds a custom section from one or more files, that isn't related to any element in the model.
addSections(SoftwareSystem, File) - Method in class com.structurizr.documentation.AutomaticDocumentationTemplate: Adds all files in the specified directory, each in its own section, related to a software system.
addSections(File) - Method in class com.structurizr.documentation.AutomaticDocumentationTemplate: Adds all files in the specified directory, each in its own section.
addSoftwareArchitectureSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Software Architecture" section relating to a SoftwareSystem.
addSoftwareArchitectureSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate: Adds a "Software Architecture" section relating to a SoftwareSystem from one or more files.
addSoftwareSystem(Location, String, String) - Method in class com.structurizr.model.Model: Creates a software system and adds it to the model.
addSoftwareSystem(String, String) - Method in class com.structurizr.model.Model: Creates a software system (with an unspecified location) and adds it to the model.
addSolutionStrategySection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Solution Strategy" section relating to a SoftwareSystem.
addSolutionStrategySection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.Arc42DocumentationTemplate: Adds a "Solution Strategy" section relating to a SoftwareSystem from one or more files.
addSupportingType(String) - Method in class com.structurizr.model.Component: Adds a supporting type to this Component.
addSystemQualitiesSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Qualities" section relating to a SoftwareSystem.
addSystemQualitiesSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Qualities" section relating to a SoftwareSystem from one or more files.
addSystemStakeholdersAndRequirementsSection(SoftwareSystem, Format, String) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem.
addSystemStakeholdersAndRequirementsSection(SoftwareSystem, File...) - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate: Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem from one or more files.
addUser(String, Role) - Method in class com.structurizr.configuration.WorkspaceConfiguration: Adds a user, with the specified username and role.
AngleBrackets - com.structurizr.view.MetadataSymbols
Arc42DocumentationTemplate - Class in com.structurizr.documentation: An implementation of the arc42 documentation template, consisting of the following sections:
Arc42DocumentationTemplate(Workspace) - Constructor for class com.structurizr.documentation.Arc42DocumentationTemplate
AsciiDoc - com.structurizr.documentation.Format
Asynchronous - com.structurizr.model.InteractionStyle: Denotes asynchronous communication.
ASYNCHRONOUS - Static variable in class com.structurizr.model.Tags: To be used for styling of asynchronous relationships
AutomaticDocumentationTemplate - Class in com.structurizr.documentation: This template allows you to scan a given directory and automatically add all Markdown or AsciiDoc files in that directory.
AutomaticDocumentationTemplate(Workspace) - Constructor for class com.structurizr.documentation.AutomaticDocumentationTemplate
AutomaticLayout - Class in com.structurizr.view: A wrapper for automatic layout configuration.
AutomaticLayout.Implementation - Enum in com.structurizr.view
AutomaticLayout.RankDirection - Enum in com.structurizr.view

B

background(String) - Method in class com.structurizr.view.ElementStyle
border(Border) - Method in class com.structurizr.view.ElementStyle
Border - Enum in com.structurizr.view
BottomTop - com.structurizr.view.AutomaticLayout.RankDirection
Box - com.structurizr.view.Shape
Branding - Class in com.structurizr.view: A wrapper for the font, logo and color scheme associated with a corporate branding.

C

canBeRemoved(Element) - Method in class com.structurizr.view.ComponentView
canBeRemoved(Element) - Method in class com.structurizr.view.ContainerView
canBeRemoved(Element) - Method in class com.structurizr.view.DeploymentView
canBeRemoved(Element) - Method in class com.structurizr.view.DynamicView
canBeRemoved(Element) - Method in class com.structurizr.view.SystemContextView
canBeRemoved(Element) - Method in class com.structurizr.view.SystemLandscapeView
canBeRemoved(Element) - Method in class com.structurizr.view.View
Circle - com.structurizr.view.Shape
clear() - Method in class com.structurizr.documentation.Documentation: Removes all documentation, decisions, and images.
clear() - Method in class com.structurizr.view.ViewSet: Removes all views and configuration.
clearConfiguration() - Method in class com.structurizr.AbstractWorkspace: Clears the configuration associated with this workspace.
clearElementStyles() - Method in class com.structurizr.view.Styles: Removes all element styles.
clearRelationshipStyles() - Method in class com.structurizr.view.Styles: Removes all relationship styles.
CodeElement - Class in com.structurizr.model: Represents a code element, such as a Java class or interface, that is part of the implementation of a component.
CodeElementRole - Enum in com.structurizr.model: Used to represent the role of a code element.
color(String) - Method in class com.structurizr.view.ElementStyle
color(String) - Method in class com.structurizr.view.RelationshipStyle
Color - Class in com.structurizr.view
Color() - Constructor for class com.structurizr.view.Color
ColorPair - Class in com.structurizr.view: Represents a pair of colours: background and foreground.
ColorPair(String, String) - Constructor for class com.structurizr.view.ColorPair
com.structurizr - package com.structurizr
com.structurizr.configuration - package com.structurizr.configuration
com.structurizr.documentation - package com.structurizr.documentation
com.structurizr.model - package com.structurizr.model
com.structurizr.util - package com.structurizr.util
com.structurizr.view - package com.structurizr.view
Component - Class in com.structurizr.model: Represents a "component" in the C4 model.
Component - com.structurizr.view.Shape
COMPONENT - Static variable in class com.structurizr.model.Tags
ComponentView - Class in com.structurizr.view: Represents a Component view from the C4 model, showing the components within a given container.
Configuration - Class in com.structurizr.view: Configuration associated with how information in the workspace is rendered.
Configuration() - Constructor for class com.structurizr.view.Configuration
Container - Class in com.structurizr.model: Represents a "container" in the C4 model.
CONTAINER - Static variable in class com.structurizr.model.Tags
CONTAINER_INSTANCE - Static variable in class com.structurizr.model.Tags
ContainerInstance - Class in com.structurizr.model: Represents a deployment instance of a Container, which can be added to a DeploymentNode.
ContainerView - Class in com.structurizr.view: Represents a Container view from the C4 model, showing the containers within a given software system.
contains(Element) - Method in class com.structurizr.model.Model: Determines whether this model contains the specified element.
copyConfigurationFrom(Configuration) - Method in class com.structurizr.view.Configuration
copyLayoutInformation(View, View) - Method in class com.structurizr.view.DefaultLayoutMergeStrategy: Attempts to copy the visual layout information (e.g.
copyLayoutInformation(View, View) - Method in interface com.structurizr.view.LayoutMergeStrategy: Attempts to copy the visual layout information (e.g.
copyLayoutInformationFrom(ViewSet) - Method in class com.structurizr.view.ViewSet
countAndLogWarnings() - Method in class com.structurizr.Workspace: Counts and logs any warnings within the workspace (e.g.
create(String...) - Static method in class com.structurizr.util.MapUtils: A helper method to create a Map from an array of Strings ("name=value").
createComponentView(Container, String, String) - Method in class com.structurizr.view.ViewSet: Creates a component view, where the scope of the view is the specified container.
createContainerView(SoftwareSystem, String, String) - Method in class com.structurizr.view.ViewSet: Creates a container view, where the scope of the view is the specified software system.
createDeploymentView(SoftwareSystem, String, String) - Method in class com.structurizr.view.ViewSet: Creates a deployment view, where the scope of the view is the specified software system.
createDeploymentView(String, String) - Method in class com.structurizr.view.ViewSet: Creates a deployment view.
createDynamicView(Container, String, String) - Method in class com.structurizr.view.ViewSet: Creates a dynamic view, where the scope is the specified container.
createDynamicView(SoftwareSystem, String, String) - Method in class com.structurizr.view.ViewSet: Creates a dynamic view, where the scope is the specified software system.
createDynamicView(String, String) - Method in class com.structurizr.view.ViewSet: Creates a dynamic view.
createFilteredView(StaticView, String, String, FilterMode, String...) - Method in class com.structurizr.view.ViewSet: Creates a FilteredView on top of an existing static view.
createImpliedRelationships(Relationship) - Method in class com.structurizr.model.CreateImpliedRelationshipsUnlessAnyRelationshipExistsStrategy
createImpliedRelationships(Relationship) - Method in class com.structurizr.model.CreateImpliedRelationshipsUnlessSameRelationshipExistsStrategy
createImpliedRelationships(Relationship) - Method in class com.structurizr.model.DefaultImpliedRelationshipsStrategy
createImpliedRelationships(Relationship) - Method in interface com.structurizr.model.ImpliedRelationshipsStrategy: Called after a relationship has been created in the model, providing an opportunity to create any resulting implied relationships.
CreateImpliedRelationshipsUnlessAnyRelationshipExistsStrategy - Class in com.structurizr.model: This strategy creates implied relationships between all valid combinations of the parent elements, unless any relationship already exists between them.
CreateImpliedRelationshipsUnlessAnyRelationshipExistsStrategy() - Constructor for class com.structurizr.model.CreateImpliedRelationshipsUnlessAnyRelationshipExistsStrategy
CreateImpliedRelationshipsUnlessSameRelationshipExistsStrategy - Class in com.structurizr.model: This strategy creates implied relationships between all valid combinations of the parent elements, unless the same relationship already exists between them.
CreateImpliedRelationshipsUnlessSameRelationshipExistsStrategy() - Constructor for class com.structurizr.model.CreateImpliedRelationshipsUnlessSameRelationshipExistsStrategy
createSystemContextView(SoftwareSystem, String, String) - Method in class com.structurizr.view.ViewSet: Creates a system context view, where the scope of the view is the specified software system.
createSystemLandscapeView(String, String) - Method in class com.structurizr.view.ViewSet: Creates a system landscape view.
CurlyBrackets - com.structurizr.view.MetadataSymbols
Curved - com.structurizr.view.Routing
Cylinder - com.structurizr.view.Shape

D

Dagre - com.structurizr.view.AutomaticLayout.Implementation
dashed(boolean) - Method in class com.structurizr.view.RelationshipStyle
Dashed - com.structurizr.view.Border
Decision - Class in com.structurizr.documentation: Represents a single (architecture) decision, as described at http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
DecisionStatus - Enum in com.structurizr.documentation: Represents the status of a decision.
Default - com.structurizr.view.ViewSortOrder
DEFAULT_HEIGHT - Static variable in class com.structurizr.view.ElementStyle
DEFAULT_WIDTH - Static variable in class com.structurizr.view.ElementStyle
DefaultImpliedRelationshipsStrategy - Class in com.structurizr.model: The default strategy is to NOT create implied relationships.
DefaultImpliedRelationshipsStrategy() - Constructor for class com.structurizr.model.DefaultImpliedRelationshipsStrategy
DefaultLayoutMergeStrategy - Class in com.structurizr.view: A default implementation of a LayoutMergeStrategy that: - Sets the paper size (if not set).
DefaultLayoutMergeStrategy() - Constructor for class com.structurizr.view.DefaultLayoutMergeStrategy
delivers(Person, String) - Method in class com.structurizr.model.Person
delivers(Person, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional relationship between this element and a person.
delivers(Person, String, String) - Method in class com.structurizr.model.Person
delivers(Person, String, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional relationship between this element and a person.
delivers(Person, String, String, InteractionStyle) - Method in class com.structurizr.model.Person
delivers(Person, String, String, InteractionStyle) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional relationship between this element and a person.
DEPLOYMENT_NODE - Static variable in class com.structurizr.model.Tags
DeploymentElement - Class in com.structurizr.model: This is the superclass for model elements that describe deployment nodes, infrastructure nodes, and container instances.
DeploymentNode - Class in com.structurizr.model: Represents a deployment node, which is something like:
DeploymentNode() - Constructor for class com.structurizr.model.DeploymentNode
DeploymentView - Class in com.structurizr.view: A deployment view, used to show the mapping of container instances to deployment nodes.
Deprecated - com.structurizr.documentation.DecisionStatus
description(boolean) - Method in class com.structurizr.view.ElementStyle
Direct - com.structurizr.view.Routing
disableAutomaticLayout() - Method in class com.structurizr.view.View: Disables automatic layout for this view.
Documentation - Class in com.structurizr.documentation: Represents the documentation within a workspace - a collection of content in Markdown or AsciiDoc format, optionally with attached images.
DocumentationTemplate - Class in com.structurizr.documentation: The superclass for all documentation templates.
DocumentationTemplate(Workspace) - Constructor for class com.structurizr.documentation.DocumentationTemplate: Creates a new documentation template for the given workspace.
Dotted - com.structurizr.view.Border
DoubleAngleBrackets - com.structurizr.view.MetadataSymbols
DynamicView - Class in com.structurizr.view: A dynamic view, used to describe behaviour between static elements at runtime.

E

Element - Class in com.structurizr.model: This is the superclass for all model elements.
Element() - Constructor for class com.structurizr.model.Element
ELEMENT - Static variable in class com.structurizr.model.Tags
ElementStyle - Class in com.structurizr.view: A definition of an element style.
ElementStyle(String, Integer, Integer, String, String, Integer) - Constructor for class com.structurizr.view.ElementStyle
ElementStyle(String, Integer, Integer, String, String, Integer, Shape) - Constructor for class com.structurizr.view.ElementStyle
ElementView - Class in com.structurizr.view: Represents an instance of an Element in a View.
Ellipse - com.structurizr.view.Shape
enableAutomaticLayout() - Method in class com.structurizr.view.View: Enables automatic layout for this view, with some default settings.
enableAutomaticLayout(AutomaticLayout.RankDirection, int, int) - Method in class com.structurizr.view.View: Enables automatic layout for this view, with the specified settings, using the Graphviz implementation.
enableAutomaticLayout(AutomaticLayout.RankDirection, int, int, int, boolean) - Method in class com.structurizr.view.View: Enables automatic layout for this view, with the specified settings, using the Dagre implementation.
endParallelSequence() - Method in class com.structurizr.view.DynamicView
endParallelSequence(boolean) - Method in class com.structurizr.view.DynamicView
Enterprise - Class in com.structurizr.model: Represents an "enterprise" (e.g.
Enterprise(String) - Constructor for class com.structurizr.model.Enterprise: Creates a new enterprise with the specified name.
equals(Object) - Method in class com.structurizr.configuration.User
equals(Object) - Method in class com.structurizr.documentation.Section
equals(Object) - Method in class com.structurizr.model.CodeElement
equals(Object) - Method in class com.structurizr.model.HttpHealthCheck
equals(Object) - Method in class com.structurizr.model.Perspective
equals(Object) - Method in class com.structurizr.view.ElementView
equals(Object) - Method in class com.structurizr.view.RelationshipView
equals(Object) - Method in class com.structurizr.view.Vertex
Exclude - com.structurizr.view.FilterMode
External - com.structurizr.model.Location

F

FilteredView - Class in com.structurizr.view: Represents a view on top of a view, which can be used to include or exclude specific elements.
FilterMode - Enum in com.structurizr.view
findElementStyle(Element) - Method in class com.structurizr.view.Styles
findElementView(View, Element) - Method in class com.structurizr.view.DefaultLayoutMergeStrategy: Finds an element by canonical name.
findRelationshipStyle(Relationship) - Method in class com.structurizr.view.Styles
findRelationshipView(View, Relationship) - Method in class com.structurizr.view.DefaultLayoutMergeStrategy
findRelationshipView(View, RelationshipView) - Method in class com.structurizr.view.DefaultLayoutMergeStrategy
Folder - com.structurizr.view.Shape
Font - Class in com.structurizr.view: Represents a font, including a name and an optional URL for web fonts.
Font(String) - Constructor for class com.structurizr.view.Font
Font(String, String) - Constructor for class com.structurizr.view.Font
fontSize(int) - Method in class com.structurizr.view.ElementStyle
fontSize(int) - Method in class com.structurizr.view.RelationshipStyle
Format - Enum in com.structurizr.documentation
found(String) - Method in interface com.structurizr.model.IdGenerator: Called when loading/deserializing a model, to indicate that the specified ID has been found (and shouldn't be reused when generating new IDs).
found(String) - Method in class com.structurizr.model.MessageDigestIdGenerator
found(String) - Method in class com.structurizr.model.NormalizedNameIdGenerator
found(String) - Method in class com.structurizr.model.SequentialIntegerIdGeneratorStrategy

G

generateId(Element) - Method in interface com.structurizr.model.IdGenerator: Generates an ID for the specified model element.
generateId(Element) - Method in class com.structurizr.model.MessageDigestIdGenerator
generateId(Element) - Method in class com.structurizr.model.NormalizedNameIdGenerator
generateId(Element) - Method in class com.structurizr.model.SequentialIntegerIdGeneratorStrategy
generateId(Relationship) - Method in interface com.structurizr.model.IdGenerator: Generates an ID for the specified model relationship.
generateId(Relationship) - Method in class com.structurizr.model.MessageDigestIdGenerator
generateId(Relationship) - Method in class com.structurizr.model.NormalizedNameIdGenerator
generateId(Relationship) - Method in class com.structurizr.model.SequentialIntegerIdGeneratorStrategy
generateId(String...) - Method in class com.structurizr.model.MessageDigestIdGenerator
getAnimations() - Method in class com.structurizr.view.DeploymentView
getAnimations() - Method in class com.structurizr.view.StaticView
getAuthor() - Method in class com.structurizr.documentation.TemplateMetadata
getAutomaticLayout() - Method in class com.structurizr.view.View: Gets the automatic layout settings for this view.
getBackground() - Method in class com.structurizr.view.ColorPair
getBackground() - Method in class com.structurizr.view.ElementStyle: Gets the background colour of the element, as a HTML RGB hex string (e.g.
getBaseViewKey() - Method in class com.structurizr.view.FilteredView
getBorder() - Method in class com.structurizr.view.ElementStyle: Gets the border used when rendering the element.
getBranding() - Method in class com.structurizr.view.Configuration: Gets the Branding object associated with this workspace.
getCanonicalName() - Method in class com.structurizr.model.Component: Gets the canonical name of this component, in the form "/Software System/Container/Component".
getCanonicalName() - Method in class com.structurizr.model.Container: Gets the canonical name of this container, in the form "/Software System/Container".
getCanonicalName() - Method in class com.structurizr.model.ContainerInstance
getCanonicalName() - Method in class com.structurizr.model.DeploymentNode
getCanonicalName() - Method in class com.structurizr.model.Element
getCanonicalName() - Method in class com.structurizr.model.InfrastructureNode
getCanonicalName() - Method in class com.structurizr.model.Person
getCanonicalName() - Method in class com.structurizr.model.SoftwareSystem: Gets the canonical name of this software system, in the form "/Software System".
getCategory() - Method in class com.structurizr.model.CodeElement: Gets the category of this code element (interface, class, etc).
getChildren() - Method in class com.structurizr.model.DeploymentNode: Gets the set of child deployment nodes.
getCode() - Method in class com.structurizr.model.Component: Gets the set of CodeElement objects.
getCode() - Method in class com.structurizr.view.Terminology
getColor() - Method in class com.structurizr.view.ElementStyle: Gets the foreground (text) colour of the element, as a HTML RGB hex string (e.g.
getColor() - Method in class com.structurizr.view.RelationshipStyle
getComponent() - Method in class com.structurizr.view.Terminology
getComponentOfType(String) - Method in class com.structurizr.model.Container: Gets the component of the specified type.
getComponents() - Method in class com.structurizr.model.Container: Gets the set of components within this software system.
getComponentViews() - Method in class com.structurizr.view.ViewSet: Gets the set of component views.
getComponentWithName(String) - Method in class com.structurizr.model.Container: Gets the component with the specified name.
getConfiguration() - Method in class com.structurizr.AbstractWorkspace: Gets the configuration associated with this workspace.
getConfiguration() - Method in class com.structurizr.view.ViewSet: Gets the configuration object associated with this set of views.
getContainer() - Method in class com.structurizr.model.Component
getContainer() - Method in class com.structurizr.model.ContainerInstance
getContainer() - Method in class com.structurizr.view.ComponentView: Gets the container associated with this view.
getContainer() - Method in class com.structurizr.view.Terminology
getContainerId() - Method in class com.structurizr.model.ContainerInstance: Gets the ID of the container that this object represents a deployment instance of.
getContainerId() - Method in class com.structurizr.view.ComponentView: Gets the ID of the container associated with this view.
getContainerInstances() - Method in class com.structurizr.model.DeploymentNode: Gets the set of container instances associated with this deployment node.
getContainers() - Method in class com.structurizr.model.SoftwareSystem: Gets the set of containers within this software system.
getContainerViews() - Method in class com.structurizr.view.ViewSet: Gets the set of container views.
getContainerWithId(String) - Method in class com.structurizr.model.SoftwareSystem: Gets the container with the specified ID.
getContainerWithName(String) - Method in class com.structurizr.model.SoftwareSystem: Gets the container with the specified name.
getContent() - Method in class com.structurizr.documentation.Decision
getContent() - Method in class com.structurizr.documentation.Image
getContent() - Method in class com.structurizr.documentation.Section
getContentType(File) - Static method in class com.structurizr.util.ImageUtils: Gets the content type of the specified file representing an image.
getDashed() - Method in class com.structurizr.view.RelationshipStyle
getDate() - Method in class com.structurizr.documentation.Decision
getDecisions() - Method in class com.structurizr.documentation.Documentation: Gets the set of decisions associated with this workspace.
getDefaultView() - Method in class com.structurizr.view.Configuration: Gets the key of the view that should be shown by default.
getDeploymentNode() - Method in class com.structurizr.view.Terminology
getDeploymentNodes() - Method in class com.structurizr.model.Model: Gets the set of all top-level deployment nodes in this model.
getDeploymentNodeWithName(String) - Method in class com.structurizr.model.DeploymentNode: Gets the DeploymentNode with the specified name.
getDeploymentNodeWithName(String) - Method in class com.structurizr.model.Model: Gets the deployment node with the specified name and default environment.
getDeploymentNodeWithName(String, String) - Method in class com.structurizr.model.Model: Gets the deployment node with the specified name and environment.
getDeploymentViews() - Method in class com.structurizr.view.ViewSet: Gets the set of dynamic views.
getDescription() - Method in class com.structurizr.AbstractWorkspace: Gets the description of this workspace.
getDescription() - Method in class com.structurizr.model.CodeElement: Gets the description of this code element.
getDescription() - Method in class com.structurizr.model.Element: Gets a description of this element.
getDescription() - Method in class com.structurizr.model.Perspective: Gets the description of this perspective.
getDescription() - Method in class com.structurizr.model.Relationship
getDescription() - Method in class com.structurizr.view.ElementStyle: Determines whether the element description should be shown or not.
getDescription() - Method in class com.structurizr.view.FilteredView
getDescription() - Method in class com.structurizr.view.RelationshipView: Gets the description of this relationship (used in dynamic views only).
getDescription() - Method in class com.structurizr.view.View: Gets the description of this view.
getDestination() - Method in class com.structurizr.model.Relationship
getDestinationId() - Method in class com.structurizr.model.Relationship: Gets the ID of the destination element.
getDocumentation() - Method in class com.structurizr.Workspace: Gets the documentation associated with this workspace.
getDynamicViews() - Method in class com.structurizr.view.ViewSet: Gets the set of dynamic views.
getEdgeSeparation() - Method in class com.structurizr.view.AutomaticLayout: Gets the edge separation (in pixels).
getEfferentRelationshipsWith(Element) - Method in class com.structurizr.model.Element: Gets the efferent (outgoing) relationship with the specified element.
getEfferentRelationshipWith(Element) - Method in class com.structurizr.model.Element: Gets the efferent (outgoing) relationship with the specified element.
getEfferentRelationshipWith(Element, String) - Method in class com.structurizr.model.Element: Determines whether this element has an efferent (outgoing) relationship with the specified element and description.
getElement() - Method in class com.structurizr.documentation.Decision
getElement() - Method in class com.structurizr.documentation.Section
getElement() - Method in class com.structurizr.view.DynamicView
getElement() - Method in class com.structurizr.view.ElementView
getElement(String) - Method in class com.structurizr.model.Model: Gets the element with the specified ID.
getElementId() - Method in class com.structurizr.documentation.Decision
getElementId() - Method in class com.structurizr.documentation.Section
getElementId() - Method in class com.structurizr.view.DynamicView: Gets the ID of the software system or container associated with this view.
getElements() - Method in class com.structurizr.model.Model: Gets the set of all elements in this model.
getElements() - Method in class com.structurizr.view.Styles
getElements() - Method in class com.structurizr.view.View: Gets the set of elements in this view.
getElementView(Element) - Method in class com.structurizr.view.View: Gets the element view for the given element.
getElementWithCanonicalName(String) - Method in class com.structurizr.model.Model: Gets the element with the specified canonical name.
getEnterprise() - Method in class com.structurizr.model.Model: Gets the enterprise associated with this model.
getEnterprise() - Method in class com.structurizr.view.Terminology
getEnvironment() - Method in class com.structurizr.model.DeploymentElement
getEnvironment() - Method in class com.structurizr.view.DeploymentView: Gets the name of the environment that this deployment view is for (e.g.
getExternalContainerBoundariesVisible() - Method in class com.structurizr.view.ComponentView: Determines whether container boundaries should be visible for "external" components (those outside the container in scope).
getExternalSoftwareSystemBoundariesVisible() - Method in class com.structurizr.view.ContainerView: Determines whether software system boundaries should be visible for "external" containers (those outside the software system in scope).
getFilteredViews() - Method in class com.structurizr.view.ViewSet
getFont() - Method in class com.structurizr.view.Branding
getFontSize() - Method in class com.structurizr.view.ElementStyle: Gets the standard font size used to render text, in pixels.
getFontSize() - Method in class com.structurizr.view.RelationshipStyle
getForeground() - Method in class com.structurizr.view.ColorPair
getFormat() - Method in class com.structurizr.documentation.Decision
getFormat() - Method in class com.structurizr.documentation.Section
getHeaders() - Method in class com.structurizr.model.HttpHealthCheck: Gets a the HTTP headers associated with this health check.
getHealthChecks() - Method in class com.structurizr.model.ContainerInstance: Gets the set of health checks associated with this container instance.
getHeight() - Method in class com.structurizr.view.ElementStyle: Gets the height of the element, in pixels.
getHeight() - Method in enum com.structurizr.view.PaperSize
getIcon() - Method in class com.structurizr.view.ElementStyle: Gets the icon of the element (a URL, or a data URI representing a Base64 encoded PNG/JPG/GIF file).
getId() - Method in class com.structurizr.AbstractWorkspace: Gets the ID of this workspace.
getId() - Method in class com.structurizr.documentation.Decision
getId() - Method in class com.structurizr.view.ElementView: Gets the ID of the Element.
getId() - Method in class com.structurizr.view.RelationshipView: Gets the ID of the relationship this RelationshipView represents.
getImageAsBase64(File) - Static method in class com.structurizr.util.ImageUtils: Gets the content of an image as a Base64 encoded string.
getImageAsDataUri(File) - Static method in class com.structurizr.util.ImageUtils: Gets the content of an image as a data URI; e.g.
getImages() - Method in class com.structurizr.documentation.Documentation: Gets the set of Images in this workspace.
getImplementation() - Method in class com.structurizr.view.AutomaticLayout: Gets the name of the implementation to use.
getImpliedRelationshipsStrategy() - Method in class com.structurizr.model.Model: Gets the strategy in use for creating implied relationships.
getInfrastructureNode() - Method in class com.structurizr.view.Terminology
getInfrastructureNodes() - Method in class com.structurizr.model.DeploymentNode: Gets the set of child infrastructure nodes.
getInfrastructureNodeWithName(String) - Method in class com.structurizr.model.DeploymentNode: Gets the infrastructure node with the specified name.
getInstance(String) - Static method in class com.structurizr.model.MessageDigestIdGenerator
getInstance(String, int) - Static method in class com.structurizr.model.MessageDigestIdGenerator
getInstanceId() - Method in class com.structurizr.model.ContainerInstance: Gets the instance ID of this container.
getInstances() - Method in class com.structurizr.model.DeploymentNode
getInteractionStyle() - Method in class com.structurizr.model.Relationship: Gets the interaction style (synchronous or asynchronous).
getInterval() - Method in class com.structurizr.model.HttpHealthCheck: Gets the polling interval of this health check.
getKey() - Method in class com.structurizr.view.FilteredView
getKey() - Method in class com.structurizr.view.View: Gets the identifier for this view.
getLanguage() - Method in class com.structurizr.model.CodeElement: Gets the programming language of this code element.
getLastModifiedAgent() - Method in class com.structurizr.AbstractWorkspace: Gets the name of the agent that was used to last modify this workspace (e.g.
getLastModifiedDate() - Method in class com.structurizr.AbstractWorkspace: Gets the last modified date of this workspace.
getLastModifiedUser() - Method in class com.structurizr.AbstractWorkspace: Gets the name of the user who last modified this workspace (e.g.
getLinkedRelationshipId() - Method in class com.structurizr.model.Relationship
getLocation() - Method in class com.structurizr.model.Person: Gets the location of this person.
getLocation() - Method in class com.structurizr.model.SoftwareSystem: Gets the location of this software system.
getLogo() - Method in class com.structurizr.view.Branding
getMetadata() - Method in class com.structurizr.documentation.Arc42DocumentationTemplate
getMetadata() - Method in class com.structurizr.documentation.AutomaticDocumentationTemplate
getMetadata() - Method in class com.structurizr.documentation.DocumentationTemplate: Gets the metadata associated with this template.
getMetadata() - Method in class com.structurizr.documentation.StructurizrDocumentationTemplate
getMetadata() - Method in class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate
getMetadata() - Method in class com.structurizr.view.ElementStyle: Determines whether the element metadata should be shown or not.
getMetadataSymbols() - Method in class com.structurizr.view.Configuration: Gets the type of symbols to use when rendering metadata.
getMode() - Method in class com.structurizr.view.FilteredView
getModel() - Method in class com.structurizr.model.Element
getModel() - Method in class com.structurizr.view.DeploymentView
getModel() - Method in class com.structurizr.view.DynamicView
getModel() - Method in class com.structurizr.view.SystemLandscapeView: Gets the model that this view belongs to.
getModel() - Method in class com.structurizr.view.View: Gets the model that this view belongs to.
getModel() - Method in class com.structurizr.Workspace: Gets the software architecture model.
getName() - Method in class com.structurizr.AbstractWorkspace: Gets the name of this workspace.
getName() - Method in class com.structurizr.documentation.Image
getName() - Method in class com.structurizr.documentation.TemplateMetadata
getName() - Method in class com.structurizr.model.CodeElement: Gets the name of this code element.
getName() - Method in class com.structurizr.model.ContainerInstance
getName() - Method in class com.structurizr.model.Element: Gets the name of this element.
getName() - Method in class com.structurizr.model.Enterprise: Gets the name of this enterprise.
getName() - Method in class com.structurizr.model.HttpHealthCheck: Gets the name of this health check.
getName() - Method in class com.structurizr.model.Perspective: Gets the name of this perspective (e.g.
getName() - Method in class com.structurizr.view.ComponentView: Gets the (computed) name of this view.
getName() - Method in class com.structurizr.view.ContainerView: Gets the (computed) name of this view.
getName() - Method in class com.structurizr.view.DeploymentView: Gets the (computed) name of this view.
getName() - Method in class com.structurizr.view.DynamicView: Gets the (computed) name of this view.
getName() - Method in class com.structurizr.view.Font
getName() - Method in enum com.structurizr.view.PaperSize
getName() - Method in class com.structurizr.view.SystemContextView: Gets the (computed) name of this view.
getName() - Method in class com.structurizr.view.SystemLandscapeView: Gets the (computed) name of this view.
getName() - Method in class com.structurizr.view.View: Gets the (computed) name of this view.
getNodeSeparation() - Method in class com.structurizr.view.AutomaticLayout: Gets the node separation (in pixels).
getOpacity() - Method in class com.structurizr.view.ElementStyle: Gets the opacity used when rendering the element.
getOpacity() - Method in class com.structurizr.view.RelationshipStyle: Gets the opacity used when rendering the relationship.
getOrder() - Method in class com.structurizr.documentation.Section
getOrder() - Method in class com.structurizr.view.RelationshipView: Gets the order of this relationship (used in dynamic views only; e.g.
getOrderedPaperSizes() - Static method in enum com.structurizr.view.PaperSize
getOrderedPaperSizes(PaperSize.Orientation) - Static method in enum com.structurizr.view.PaperSize
getOrientation() - Method in enum com.structurizr.view.PaperSize
getPackage() - Method in class com.structurizr.model.CodeElement: Gets the Java package of this component (i.e.
getPaperSize() - Method in class com.structurizr.view.View: Gets the paper size that should be used to render this view.
getParent() - Method in class com.structurizr.model.Component
getParent() - Method in class com.structurizr.model.Container: Gets the parent software system.
getParent() - Method in class com.structurizr.model.ContainerInstance
getParent() - Method in class com.structurizr.model.DeploymentNode: Gets the parent deployment node.
getParent() - Method in class com.structurizr.model.Element: Gets the parent of this element.
getParent() - Method in class com.structurizr.model.InfrastructureNode: Gets the parent deployment node.
getParent() - Method in class com.structurizr.model.Person
getParent() - Method in class com.structurizr.model.SoftwareSystem: Gets the parent of this software system.
getPeople() - Method in class com.structurizr.model.Model: Gets the set of all people in this model.
getPerson() - Method in class com.structurizr.view.Terminology
getPersonWithName(String) - Method in class com.structurizr.model.Model: Gets the person with the specified name.
getPosition() - Method in class com.structurizr.view.RelationshipStyle
getPosition() - Method in class com.structurizr.view.RelationshipView: Gets the position of the annotation along the line.
getRankDirection() - Method in class com.structurizr.view.AutomaticLayout: Gets the rank direction.
getRankSeparation() - Method in class com.structurizr.view.AutomaticLayout: Gets the rank separation (in pixels).
getRelationship() - Method in class com.structurizr.view.RelationshipView: Gets the relationship that this RelationshipView represents.
getRelationship() - Method in class com.structurizr.view.Terminology
getRelationship(String) - Method in class com.structurizr.model.Model: Gets the relationship with the specified ID.
getRelationships() - Method in class com.structurizr.model.Element: Gets the set of outgoing relationships.
getRelationships() - Method in class com.structurizr.model.Model: Gets the set of all relationships in this model.
getRelationships() - Method in class com.structurizr.view.DynamicView: Gets the set of RelationshipView objects for this view, ordered by the order property.
getRelationships() - Method in class com.structurizr.view.Styles
getRelationships() - Method in class com.structurizr.view.View: Gets the set of relationships in this view.
getRelationshipView(Relationship) - Method in class com.structurizr.view.View: Gets the relationship view for the given relationship.
getRequiredTags() - Method in class com.structurizr.model.Component
getRequiredTags() - Method in class com.structurizr.model.Container
getRequiredTags() - Method in class com.structurizr.model.ContainerInstance
getRequiredTags() - Method in class com.structurizr.model.DeploymentNode
getRequiredTags() - Method in class com.structurizr.model.InfrastructureNode
getRequiredTags() - Method in class com.structurizr.model.Person
getRequiredTags() - Method in class com.structurizr.model.Relationship
getRequiredTags() - Method in class com.structurizr.model.SoftwareSystem
getRevision() - Method in class com.structurizr.AbstractWorkspace: Gets the revision number of this workspace.
getRole() - Method in class com.structurizr.configuration.User: Gets the role.
getRole() - Method in class com.structurizr.model.CodeElement: Gets the role of this code element; Primary or Supporting.
getRouting() - Method in class com.structurizr.view.RelationshipStyle
getRouting() - Method in class com.structurizr.view.RelationshipView: Gets the routing algorithm used when rendering this relationship.
getSections() - Method in class com.structurizr.documentation.Documentation: Gets the set of Sections.
getShape() - Method in class com.structurizr.view.ElementStyle: Gets the shape used to render the element.
getSize() - Method in class com.structurizr.model.CodeElement: Gets the size of this code element (e.g.
getSize() - Method in class com.structurizr.model.Component: Gets the size of this Component (e.g.
getSoftwareSystem() - Method in class com.structurizr.model.Container: Gets the parent software system.
getSoftwareSystem() - Method in class com.structurizr.view.Terminology
getSoftwareSystem() - Method in class com.structurizr.view.View: Gets the software system that this view is associated with.
getSoftwareSystemId() - Method in class com.structurizr.view.ComponentView
getSoftwareSystemId() - Method in class com.structurizr.view.DynamicView
getSoftwareSystemId() - Method in class com.structurizr.view.View: Gets the ID of the software system this view is associated with.
getSoftwareSystems() - Method in class com.structurizr.model.Model: Gets the set of all software systems in this model.
getSoftwareSystemWithId(String) - Method in class com.structurizr.model.Model: Gets the software system with the specified ID.
getSoftwareSystemWithName(String) - Method in class com.structurizr.model.Model: Gets the software system with the specified name.
getSource() - Method in class com.structurizr.model.Relationship
getSourceId() - Method in class com.structurizr.model.Relationship: Gets the ID of the source element.
getStatus() - Method in class com.structurizr.documentation.Decision
getStroke() - Method in class com.structurizr.view.ElementStyle: Gets the stroke colour of the element, as a HTML RGB hex string (e.g.
getStyles() - Method in class com.structurizr.view.Configuration: Gets the styles associated with this set of views.
getSystemContextViews() - Method in class com.structurizr.view.ViewSet: Gets the set of system context views.
getSystemLandscapeViews() - Method in class com.structurizr.view.ViewSet: Gets the set of system landscape views.
getTag() - Method in class com.structurizr.view.ElementStyle: The tag to which this element style applies.
getTag() - Method in class com.structurizr.view.RelationshipStyle
getTags() - Method in class com.structurizr.view.FilteredView
getTechnology() - Method in class com.structurizr.model.Component: Gets the technology associated with this component (e.g.
getTechnology() - Method in class com.structurizr.model.Container: Gets the technology associated with this container (e.g.
getTechnology() - Method in class com.structurizr.model.DeploymentNode
getTechnology() - Method in class com.structurizr.model.InfrastructureNode
getTechnology() - Method in class com.structurizr.model.Relationship: Gets the technology associated with this relationship (e.g.
getTemplate() - Method in class com.structurizr.documentation.Documentation: Gets the template metadata associated with this documentation.
getTerminology() - Method in class com.structurizr.view.Configuration: Gets the Terminology object associated with this workspace.
getTheme() - Method in class com.structurizr.view.Configuration: Deprecated.
getThemes() - Method in class com.structurizr.view.Configuration: Gets the URLs of the themes used to render views.
getThickness() - Method in class com.structurizr.view.RelationshipStyle
getThumbnail() - Method in class com.structurizr.AbstractWorkspace: Gets the thumbnail associated with this workspace.
getTimeout() - Method in class com.structurizr.model.HttpHealthCheck: Gets the timeout associated with this health check.
getTitle() - Method in class com.structurizr.documentation.Decision
getTitle() - Method in class com.structurizr.documentation.Section
getTitle() - Method in class com.structurizr.view.View: Gets the title of this view, if one has been set.
getType() - Method in class com.structurizr.documentation.Image
getType() - Method in class com.structurizr.model.CodeElement: Gets the type (fully qualified type name) of this code element.
getType() - Method in class com.structurizr.model.Component: Gets the type of this component (e.g.
getUrl() - Method in class com.structurizr.documentation.TemplateMetadata
getUrl() - Method in class com.structurizr.model.CodeElement: Gets the URL where more information about this code element can be found.
getUrl() - Method in class com.structurizr.model.Element: Gets the URL where more information about this element can be found.
getUrl() - Method in class com.structurizr.model.HttpHealthCheck: Gets the URL for this health check.
getUrl() - Method in class com.structurizr.model.Relationship: Gets the URL where more information about this relationship can be found.
getUrl() - Method in class com.structurizr.view.Font
getUsername() - Method in class com.structurizr.configuration.User: Gets the username (e.g.
getUsers() - Method in class com.structurizr.configuration.WorkspaceConfiguration: Gets the set of users should have read-write or read-only access to the workspace.
getVersion() - Method in class com.structurizr.AbstractWorkspace: Gets the version of this workspace.
getVertices() - Method in class com.structurizr.view.RelationshipView: Gets the set of vertices used to render the relationship.
getView() - Method in class com.structurizr.view.FilteredView
getViews() - Method in class com.structurizr.view.ViewSet: Gets the set of all views (except filtered views).
getViews() - Method in class com.structurizr.Workspace: Gets the set of views onto a software architecture model.
getViewSet() - Method in class com.structurizr.view.View: Gets the view set that this view belongs to.
getViewSortOrder() - Method in class com.structurizr.view.Configuration: Gets the sort order used when displaying the list of views.
getVisibility() - Method in class com.structurizr.model.CodeElement: Gets the visibility of this code element (public, package, etc).
getWidth() - Method in class com.structurizr.view.ElementStyle: Gets the width of the element, in pixels.
getWidth() - Method in enum com.structurizr.view.PaperSize
getWidth() - Method in class com.structurizr.view.RelationshipStyle
getX() - Method in class com.structurizr.view.ElementView: Gets the horizontal position of the element when rendered.
getX() - Method in class com.structurizr.view.Vertex: Gets the horizontal position of the vertex when rendered.
getY() - Method in class com.structurizr.view.ElementView: Gets the vertical position of the element when rendered.
getY() - Method in class com.structurizr.view.Vertex: Gets the vertical position of the vertex when rendered.
Graphviz - com.structurizr.view.AutomaticLayout.Implementation

H

hasAfferentRelationships() - Method in class com.structurizr.model.Element: Determines whether this element has afferent (incoming) relationships.
hasChildren() - Method in class com.structurizr.model.DeploymentNode
hasEfferentRelationshipWith(Element) - Method in class com.structurizr.model.Element: Determines whether this element has an efferent (outgoing) relationship with the specified element.
hasEfferentRelationshipWith(Element, String) - Method in class com.structurizr.model.Element: Determines whether this element has an efferent (outgoing) relationship with the specified element and description.
hashCode() - Method in class com.structurizr.configuration.User
hashCode() - Method in class com.structurizr.documentation.Section
hashCode() - Method in class com.structurizr.model.CodeElement
hashCode() - Method in class com.structurizr.model.HttpHealthCheck
hashCode() - Method in class com.structurizr.model.Perspective
hashCode() - Method in class com.structurizr.view.ElementView
hashCode() - Method in class com.structurizr.view.RelationshipView
hashCode() - Method in class com.structurizr.view.Vertex
height(int) - Method in class com.structurizr.view.ElementStyle
Hexagon - com.structurizr.view.Shape
HttpHealthCheck - Class in com.structurizr.model: Describes a HTTP based health check.
hydrate() - Method in class com.structurizr.Workspace: Called when deserialising JSON, to re-create the object graph based upon element/relationship IDs.

I

icon(String) - Method in class com.structurizr.view.ElementStyle
IdGenerator - Interface in com.structurizr.model: The interface that ID generators, used when creating IDs for model elements, must implement.
Image - Class in com.structurizr.documentation: Represents a base64 encoded image (png/jpg/gif).
ImageUtils - Class in com.structurizr.util: Some utility methods for dealing with images.
ImageUtils() - Constructor for class com.structurizr.util.ImageUtils
impliedRelationshipIsAllowed(Element, Element) - Method in class com.structurizr.model.AbstractImpliedRelationshipsStrategy
ImpliedRelationshipsStrategy - Interface in com.structurizr.model: Defines the interface for strategies to create implied relationships in the model, after a relationship has been created.
Include - com.structurizr.view.FilterMode
INFRASTRUCTURE_NODE - Static variable in class com.structurizr.model.Tags
InfrastructureNode - Class in com.structurizr.model: Represents an infrastructure node, which is something like:
InfrastructureNode() - Constructor for class com.structurizr.model.InfrastructureNode
InteractionStyle - Enum in com.structurizr.model: Use InteractionStyles on Relationships to make the difference between synchronous and asynchronous communication visible.
interactsWith(Person, String) - Method in class com.structurizr.model.Person: Adds an interaction between this person and another.
interactsWith(Person, String, String) - Method in class com.structurizr.model.Person: Adds an interaction between this person and another.
interactsWith(Person, String, String, InteractionStyle) - Method in class com.structurizr.model.Person: Adds an interaction between this person and another.
Internal - com.structurizr.model.Location
isElementInView(Element) - Method in class com.structurizr.view.View
isEmpty() - Method in class com.structurizr.documentation.Documentation
isEmpty() - Method in class com.structurizr.model.Model: Determines whether this model is empty.
isEmpty() - Method in class com.structurizr.view.ViewSet
isEmpty() - Method in class com.structurizr.Workspace: Determines whether this model is empty.
isEnterpriseBoundaryVisible() - Method in class com.structurizr.view.SystemContextView: Determines whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.
isEnterpriseBoundaryVisible() - Method in class com.structurizr.view.SystemLandscapeView: Determines whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.
isHexColorCode(String) - Static method in class com.structurizr.view.Color
isNullOrEmpty(String) - Static method in class com.structurizr.util.StringUtils
isUrl(String) - Static method in class com.structurizr.util.Url: Determines whether the supplied string is a valid URL.
isVertices() - Method in class com.structurizr.view.AutomaticLayout: Gets whether the automatic layout algorithm should create vertices.

K

Key - com.structurizr.view.ViewSortOrder

L

Landscape - com.structurizr.view.PaperSize.Orientation
LayoutMergeStrategy - Interface in com.structurizr.view: A pluggable strategy that can be used to copy layout information from one version of a view to another.
LeftRight - com.structurizr.view.AutomaticLayout.RankDirection
Legal_Landscape - com.structurizr.view.PaperSize
Legal_Portrait - com.structurizr.view.PaperSize
Letter_Landscape - com.structurizr.view.PaperSize
Letter_Portrait - com.structurizr.view.PaperSize
Location - Enum in com.structurizr.model: Represents the location of an element with regards to a specific viewpoint.

M

MapUtils - Class in com.structurizr.util
MapUtils() - Constructor for class com.structurizr.util.MapUtils
Markdown - com.structurizr.documentation.Format
MessageDigestIdGenerator - Class in com.structurizr.model: An ID generator that uses a digest function when generating IDs for model elements and relationships.
MessageDigestIdGenerator(MessageDigest, int) - Constructor for class com.structurizr.model.MessageDigestIdGenerator
metadata(boolean) - Method in class com.structurizr.view.ElementStyle
MetadataSymbols - Enum in com.structurizr.view: The type of symbols to use when rendering metadata.
MobileDeviceLandscape - com.structurizr.view.Shape
MobileDevicePortrait - com.structurizr.view.Shape
Model - Class in com.structurizr.model: Represents a software architecture model, into which all model elements are added.
modifyRelationship(Relationship, String, String) - Method in class com.structurizr.model.Model: Provides a way for the description and technology to be modified on an existing relationship.

N

None - com.structurizr.view.MetadataSymbols
NormalizedNameIdGenerator - Class in com.structurizr.model: An ID generator that uses the element name to generate IDs for model elements and relationships.
NormalizedNameIdGenerator() - Constructor for class com.structurizr.model.NormalizedNameIdGenerator: Creates a new ID generator, where element IDs are based upon the canonical name of the element.
NormalizedNameIdGenerator(boolean) - Constructor for class com.structurizr.model.NormalizedNameIdGenerator: Creates a new ID generator.

O

opacity(int) - Method in class com.structurizr.view.ElementStyle
opacity(int) - Method in class com.structurizr.view.RelationshipStyle
Orthogonal - com.structurizr.view.Routing

P

PaperSize - Enum in com.structurizr.view: These represent paper sizes in pixels at 300dpi.
PaperSize.Orientation - Enum in com.structurizr.view
Person - Class in com.structurizr.model: Represents a "person" in the C4 model.
Person - com.structurizr.view.Shape
PERSON - Static variable in class com.structurizr.model.Tags
Perspective - Class in com.structurizr.model: Represents an architectural perspective, that can be applied to elements and relationships.
Pipe - com.structurizr.view.Shape
Portrait - com.structurizr.view.PaperSize.Orientation
position(int) - Method in class com.structurizr.view.RelationshipStyle
Primary - com.structurizr.model.CodeElementRole
Proposed - com.structurizr.documentation.DecisionStatus

R

ReadOnly - com.structurizr.configuration.Role
ReadWrite - com.structurizr.configuration.Role
Rejected - com.structurizr.documentation.DecisionStatus
Relationship - Class in com.structurizr.model: A relationship between two elements.
RELATIONSHIP - Static variable in class com.structurizr.model.Tags
RelationshipStyle - Class in com.structurizr.view
RelationshipStyle(String, Integer, String, Boolean, Routing, Integer, Integer, Integer) - Constructor for class com.structurizr.view.RelationshipStyle
RelationshipView - Class in com.structurizr.view: This class represents an instance of a Relationship on a View.
remove(Component) - Method in class com.structurizr.view.ComponentView: Removes an individual component from this view.
remove(Container) - Method in class com.structurizr.view.ComponentView: Removes an individual container from this view.
remove(Container) - Method in class com.structurizr.view.ContainerView: Removes an individual container from this view.
remove(Person) - Method in class com.structurizr.view.StaticView: Removes the given person from this view.
remove(Relationship) - Method in class com.structurizr.view.View: Removes a relationship from this view.
remove(SoftwareSystem) - Method in class com.structurizr.view.StaticView: Removes the given software system from this view.
removeElement(Element) - Method in class com.structurizr.view.View
removeElementsThatAreUnreachableFrom(Element) - Method in class com.structurizr.view.StaticView: Removes all elements that cannot be reached by traversing the graph of relationships starting with the specified element.
removeElementsWithNoRelationships() - Method in class com.structurizr.view.View: Removes all elements that have no relationships to other elements in this view.
removeElementsWithTag(String) - Method in class com.structurizr.view.StaticView: Removes all Elements that have the given tag from this view.
removeRelationshipsNotConnectedToElement(Element) - Method in class com.structurizr.view.View: Removes relationships that are not connected to the specified element.
removeRelationshipsWithTag(String) - Method in class com.structurizr.view.StaticView: Removes all Relationships that have the given tag from this view.
removeTag(String) - Method in class com.structurizr.model.ContainerInstance
RightLeft - com.structurizr.view.AutomaticLayout.RankDirection
Robot - com.structurizr.view.Shape
Role - Enum in com.structurizr.configuration: Represents the access that a user has to a workspace.
RoundBrackets - com.structurizr.view.MetadataSymbols
RoundedBox - com.structurizr.view.Shape
routing(Routing) - Method in class com.structurizr.view.RelationshipStyle
Routing - Enum in com.structurizr.view

S

Section - Class in com.structurizr.documentation: A documentation section.
SequentialIntegerIdGeneratorStrategy - Class in com.structurizr.model: An ID generator that simply uses a sequential number when generating IDs for model elements and relationships.
SequentialIntegerIdGeneratorStrategy() - Constructor for class com.structurizr.model.SequentialIntegerIdGeneratorStrategy
setBackground(String) - Method in class com.structurizr.view.ColorPair
setBackground(String) - Method in class com.structurizr.view.ElementStyle
setBorder(Border) - Method in class com.structurizr.view.ElementStyle
setCategory(String) - Method in class com.structurizr.model.CodeElement: Sets the category of this code element.
setCode(String) - Method in class com.structurizr.view.Terminology
setColor(String) - Method in class com.structurizr.view.ElementStyle
setColor(String) - Method in class com.structurizr.view.RelationshipStyle
setComponent(String) - Method in class com.structurizr.view.Terminology
setConfiguration(WorkspaceConfiguration) - Method in class com.structurizr.AbstractWorkspace
setContainer(String) - Method in class com.structurizr.view.Terminology
setDashed(Boolean) - Method in class com.structurizr.view.RelationshipStyle
setDefaultView(View) - Method in class com.structurizr.view.Configuration: Sets the view that should be shown by default.
setDeploymentNode(String) - Method in class com.structurizr.view.Terminology
setDescription(Boolean) - Method in class com.structurizr.view.ElementStyle: Sets whether the element description should be shown or not.
setDescription(String) - Method in class com.structurizr.AbstractWorkspace: Sets the description of this workspace.
setDescription(String) - Method in class com.structurizr.model.CodeElement: Sets the description of this code element.
setDescription(String) - Method in class com.structurizr.model.Element: Sets the description of this element.
setDescription(String) - Method in class com.structurizr.view.RelationshipView: Sets the description of this relationship (used in dynamic views only).
setDescription(String) - Method in class com.structurizr.view.View
setEnterprise(Enterprise) - Method in class com.structurizr.model.Model: Sets the enterprise associated with this model.
setEnterprise(String) - Method in class com.structurizr.view.Terminology
setEnterpriseBoundaryVisible(boolean) - Method in class com.structurizr.view.SystemContextView: Sets whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.
setEnterpriseBoundaryVisible(boolean) - Method in class com.structurizr.view.SystemLandscapeView: Sets whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.
setEnvironment(String) - Method in class com.structurizr.view.DeploymentView: Sets the name of the environment that this deployment view is for (e.g.
setExternalSoftwareSystemBoundariesVisible(boolean) - Method in class com.structurizr.view.ComponentView: Sets whether container boundaries should be visible for "external" components (those outside the container in scope).
setExternalSoftwareSystemBoundariesVisible(boolean) - Method in class com.structurizr.view.ContainerView: Sets whether software system boundaries should be visible for "external" containers (those outside the software system in scope).
setFont(Font) - Method in class com.structurizr.view.Branding: Sets the font to use.
setFontSize(Integer) - Method in class com.structurizr.view.ElementStyle
setFontSize(Integer) - Method in class com.structurizr.view.RelationshipStyle
setForeground(String) - Method in class com.structurizr.view.ColorPair
setHeight(Integer) - Method in class com.structurizr.view.ElementStyle
setIcon(String) - Method in class com.structurizr.view.ElementStyle
setId(long) - Method in class com.structurizr.AbstractWorkspace: Sets the ID of this workspace.
setIdGenerator(IdGenerator) - Method in class com.structurizr.model.Model: Sets the ID generator associated with this model.
setImpliedRelationshipsStrategy(ImpliedRelationshipsStrategy) - Method in class com.structurizr.model.Model: Sets the strategy is use for creating implied relationships.
setInfrastructureNode(String) - Method in class com.structurizr.view.Terminology
setInstances(int) - Method in class com.structurizr.model.DeploymentNode
setLanguage(String) - Method in class com.structurizr.model.CodeElement: Sets the programming language of this code element.
setLastModifiedAgent(String) - Method in class com.structurizr.AbstractWorkspace: Sets the name of the agent that was used to last modify this workspace (e.g.
setLastModifiedDate(Date) - Method in class com.structurizr.AbstractWorkspace: Sets the last modified date of this workspace.
setLastModifiedUser(String) - Method in class com.structurizr.AbstractWorkspace: Sets the name of the user who last modified tihs workspace (e.g.
setLayoutMergeStrategy(LayoutMergeStrategy) - Method in class com.structurizr.view.View: Sets the strategy used for merging layout information (paper size, x/y positioning, etc) from one version of this view to another.
setLocation(Location) - Method in class com.structurizr.model.Person
setLocation(Location) - Method in class com.structurizr.model.SoftwareSystem: Sets the location of this software system.
setLogo(String) - Method in class com.structurizr.view.Branding: Sets the URL of an image representing a logo.
setMetadata(Boolean) - Method in class com.structurizr.view.ElementStyle: Sets whether the element metadata should be shown or not.
setMetadataSymbols(MetadataSymbols) - Method in class com.structurizr.view.Configuration: Sets the type of symbols to use when rendering metadata.
setModel(Model) - Method in class com.structurizr.model.Element
setName(String) - Method in class com.structurizr.AbstractWorkspace: Sets the name of this workspace.
setName(String) - Method in class com.structurizr.model.ContainerInstance
setName(String) - Method in class com.structurizr.view.Font: The name of the font family to use; e.g.
setOpacity(Integer) - Method in class com.structurizr.view.ElementStyle
setOpacity(Integer) - Method in class com.structurizr.view.RelationshipStyle
setOrder(int) - Method in class com.structurizr.documentation.Section
setOrder(String) - Method in class com.structurizr.view.RelationshipView: Sets the order of this relationship (used in dynamic views only; e.g.
setPaperSize(PaperSize) - Method in class com.structurizr.view.View
setPerson(String) - Method in class com.structurizr.view.Terminology
setPosition(Integer) - Method in class com.structurizr.view.RelationshipStyle
setPosition(Integer) - Method in class com.structurizr.view.RelationshipView: Sets the position of the annotation along the line.
setRelationship(String) - Method in class com.structurizr.view.Terminology
setRevision(Long) - Method in class com.structurizr.AbstractWorkspace: Sets the revision number of this workspace.
setRouting(Routing) - Method in class com.structurizr.view.RelationshipStyle
setRouting(Routing) - Method in class com.structurizr.view.RelationshipView: Sets the routing algorithm used when rendering this relationship.
setShape(Shape) - Method in class com.structurizr.view.ElementStyle
setSize(long) - Method in class com.structurizr.model.CodeElement: Sets the size of this code element.
setSize(long) - Method in class com.structurizr.model.Component: Sets the size of this component (e.g.
setSoftwareSystem(String) - Method in class com.structurizr.view.Terminology
setStroke(String) - Method in class com.structurizr.view.ElementStyle
setTag(String) - Method in class com.structurizr.view.ElementStyle
setTag(String) - Method in class com.structurizr.view.RelationshipStyle
setTechnology(String) - Method in class com.structurizr.model.Component: Sets the technology associated with this component (e.g.
setTechnology(String) - Method in class com.structurizr.model.Container: Sets the technology associated with this container.
setTechnology(String) - Method in class com.structurizr.model.DeploymentNode
setTechnology(String) - Method in class com.structurizr.model.InfrastructureNode
setTheme(String) - Method in class com.structurizr.view.Configuration: Sets the theme used to render views.
setThemes(String...) - Method in class com.structurizr.view.Configuration: Sets the themes used to render views.
setThickness(Integer) - Method in class com.structurizr.view.RelationshipStyle
setThumbnail(String) - Method in class com.structurizr.AbstractWorkspace: Sets the thumbnail associated with this workspace.
setTitle(String) - Method in class com.structurizr.view.View: Sets the title for this view.
setType(String) - Method in class com.structurizr.model.Component: Sets the type of this component (e.g.
setUrl(String) - Method in class com.structurizr.model.CodeElement: Sets the URL where more information about this code element can be found.
setUrl(String) - Method in class com.structurizr.model.Element: Sets the URL where more information about this element can be found.
setUrl(String) - Method in class com.structurizr.model.Relationship: Sets the URL where more information about this relationship can be found.
setUrl(String) - Method in class com.structurizr.view.Font: Sets the URL where the web font can be found.
setVersion(String) - Method in class com.structurizr.AbstractWorkspace: Sets the version of this workspace.
setVertices(Collection<Vertex>) - Method in class com.structurizr.view.RelationshipView: Sets the collection of vertices used when rendering this relationship.
setViewSortOrder(ViewSortOrder) - Method in class com.structurizr.view.Configuration: Sets the sort order used when displaying the list of views.
setVisibility(String) - Method in class com.structurizr.model.CodeElement: Sets the visibility of this code element.
setWidth(Integer) - Method in class com.structurizr.view.ElementStyle
setWidth(Integer) - Method in class com.structurizr.view.RelationshipStyle
setX(int) - Method in class com.structurizr.view.ElementView
setX(int) - Method in class com.structurizr.view.Vertex
setY(int) - Method in class com.structurizr.view.ElementView
setY(int) - Method in class com.structurizr.view.Vertex
shape(Shape) - Method in class com.structurizr.view.ElementStyle
Shape - Enum in com.structurizr.view
Slide_16_10 - com.structurizr.view.PaperSize
Slide_16_9 - com.structurizr.view.PaperSize
Slide_4_3 - com.structurizr.view.PaperSize
SOFTWARE_SYSTEM - Static variable in class com.structurizr.model.Tags
SoftwareSystem - Class in com.structurizr.model: Represents a "software system" in the C4 model.
Solid - com.structurizr.view.Border
SquareBrackets - com.structurizr.view.MetadataSymbols
startParallelSequence() - Method in class com.structurizr.view.DynamicView
StaticStructureElement - Class in com.structurizr.model: This is the superclass for model elements that describe the static structure of a software system, namely Person, SoftwareSystem, Container and Component.
StaticStructureElement() - Constructor for class com.structurizr.model.StaticStructureElement
StaticView - Class in com.structurizr.view: The superclass for all static views (system landscape, system context, container and component views).
StringUtils - Class in com.structurizr.util
StringUtils() - Constructor for class com.structurizr.util.StringUtils
stroke(String) - Method in class com.structurizr.view.ElementStyle
StructurizrDocumentationTemplate - Class in com.structurizr.documentation: A simple documentation template, based upon the "software guidebook" concept in Simon Brown's Software Architecture for Developers book, with the following sections:
StructurizrDocumentationTemplate(Workspace) - Constructor for class com.structurizr.documentation.StructurizrDocumentationTemplate
Styles - Class in com.structurizr.view
Styles() - Constructor for class com.structurizr.view.Styles
Superseded - com.structurizr.documentation.DecisionStatus
Supporting - com.structurizr.model.CodeElementRole
Synchronous - com.structurizr.model.InteractionStyle: Denotes synchronous communication.
SYNCHRONOUS - Static variable in class com.structurizr.model.Tags: To be used for styling of synchronous relationships
SystemContextView - Class in com.structurizr.view: 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 - Class in com.structurizr.view: Represents a System Landscape view that sits "above" the C4 model, showing the software systems and people in a given environment.

T

Tags - Class in com.structurizr.model
Tags() - Constructor for class com.structurizr.model.Tags
TemplateMetadata - Class in com.structurizr.documentation: Represents some basic metadata about the documentation template being used.
TemplateMetadata(String, String, String) - Constructor for class com.structurizr.documentation.TemplateMetadata
Terminology - Class in com.structurizr.view: Provides a way for the terminology on diagrams, etc to be modified (e.g.
Terminology() - Constructor for class com.structurizr.view.Terminology
thickness(int) - Method in class com.structurizr.view.RelationshipStyle
TopBottom - com.structurizr.view.AutomaticLayout.RankDirection
toString() - Method in class com.structurizr.configuration.User
toString() - Method in class com.structurizr.model.Element
toString() - Method in class com.structurizr.model.Relationship
toString() - Method in class com.structurizr.view.DynamicView
toString() - Method in class com.structurizr.view.ElementView
toString() - Method in class com.structurizr.view.RelationshipView
Type - com.structurizr.view.ViewSortOrder

U

Unspecified - com.structurizr.model.Location
Url - Class in com.structurizr.util: Utilities for dealing with URLs.
Url() - Constructor for class com.structurizr.util.Url
User - Class in com.structurizr.configuration: Represents a user, and the role-based access they have to a workspace.
uses(Component, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and component.
uses(Component, String, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a component.
uses(Component, String, String, InteractionStyle) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a component.
uses(Container, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and container.
uses(Container, String, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a container.
uses(Container, String, String, InteractionStyle) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a container.
uses(DeploymentElement, String, String) - Method in class com.structurizr.model.InfrastructureNode: Adds a relationship between this and another deployment element (deployment node, infrastructure node, or container instance).
uses(DeploymentElement, String, String, InteractionStyle) - Method in class com.structurizr.model.InfrastructureNode: Adds a relationship between this and another deployment element (deployment node, infrastructure node, or container instance).
uses(DeploymentNode, String, String) - Method in class com.structurizr.model.DeploymentNode: Adds a relationship between this and another deployment node.
uses(DeploymentNode, String, String, InteractionStyle) - Method in class com.structurizr.model.DeploymentNode: Adds a relationship between this and another deployment node.
uses(SoftwareSystem, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and software system.
uses(SoftwareSystem, String, String) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a software system.
uses(SoftwareSystem, String, String, InteractionStyle) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a software system.
uses(StaticStructureElement, String, String, InteractionStyle) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and the specified element.

V

valueOf(String) - Static method in enum com.structurizr.configuration.Role: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.documentation.DecisionStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.documentation.Format: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.model.CodeElementRole: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.model.InteractionStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.model.Location: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.AutomaticLayout.Implementation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.AutomaticLayout.RankDirection: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.Border: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.FilterMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.MetadataSymbols: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.PaperSize.Orientation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.PaperSize: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.Routing: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.Shape: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.structurizr.view.ViewSortOrder: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.structurizr.configuration.Role: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.documentation.DecisionStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.documentation.Format: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.model.CodeElementRole: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.model.InteractionStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.model.Location: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.AutomaticLayout.Implementation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.AutomaticLayout.RankDirection: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.Border: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.FilterMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.MetadataSymbols: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.PaperSize.Orientation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.PaperSize: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.Routing: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.Shape: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.structurizr.view.ViewSortOrder: Returns an array containing the constants of this enum type, in the order they are declared.
Vertex - Class in com.structurizr.view: The X, Y coordinate of a bend in a line.
Vertex(int, int) - Constructor for class com.structurizr.view.Vertex
View - Class in com.structurizr.view: The superclass for all views (static views, dynamic views and deployment views).
ViewpointsAndPerspectivesDocumentationTemplate - Class in com.structurizr.documentation: 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(Workspace) - Constructor for class com.structurizr.documentation.ViewpointsAndPerspectivesDocumentationTemplate
ViewSet - Class in com.structurizr.view: A set of views onto a software architecture model.
ViewSortOrder - Enum in com.structurizr.view: Allows the sort order of views to be customized as follows:

W

WebBrowser - com.structurizr.view.Shape
width(int) - Method in class com.structurizr.view.ElementStyle
width(int) - Method in class com.structurizr.view.RelationshipStyle
Workspace - Class in com.structurizr: Represents a Structurizr workspace, which is a wrapper for a software architecture model, views and documentation.
Workspace(String, String) - Constructor for class com.structurizr.Workspace: Creates a new workspace.
WorkspaceConfiguration - Class in com.structurizr.configuration: A wrapper for configuration options related to the workspace.
WorkspaceValidationException - Exception in com.structurizr
WorkspaceValidationException(String) - Constructor for exception com.structurizr.WorkspaceValidationException

A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages