Index (structurizr-core 1.21.0 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A0_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A0_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
A1_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A1_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
A2_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A2_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
A3_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A3_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
A4_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A4_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
A5_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A5_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
A6_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
A6_Portrait - Enum constant in enum class 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
AbstractStyle - Class in com.structurizr.view
AbstractStyle() - Constructor for class com.structurizr.view.AbstractStyle
AbstractWorkspace - Class in com.structurizr: The superclass for regular and encrypted workspaces.
AbstractWorkspace() - Constructor for class com.structurizr.AbstractWorkspace
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 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(ContainerInstance) - Method in class com.structurizr.view.DeploymentView: Adds a container instance (and its parent deployment nodes) to this view.
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(Container, String...) - Method in class com.structurizr.model.DeploymentNode: Adds a container instance to this deployment node, optionally replicating relationships.
add(CustomElement) - Method in class com.structurizr.view.CustomView: Adds the given custom element to this view, including relationships to/from that custom element.
add(CustomElement) - Method in class com.structurizr.view.DeploymentView: Adds the given custom element to this view, including relationships to/from that custom element.
add(CustomElement) - Method in class com.structurizr.view.StaticView: Adds the given custom element to this view, including relationships to/from that custom element.
add(CustomElement, boolean) - Method in class com.structurizr.view.CustomView: Adds the given custom element to this view.
add(CustomElement, boolean) - Method in class com.structurizr.view.DeploymentView: Adds the given custom element to this view.
add(CustomElement, boolean) - Method in class com.structurizr.view.StaticView: Adds the given custom element to this view.
add(CustomElement, CustomElement) - Method in class com.structurizr.view.DynamicView
add(CustomElement, StaticStructureElement) - Method in class com.structurizr.view.DynamicView
add(CustomElement, String, CustomElement) - Method in class com.structurizr.view.DynamicView
add(CustomElement, String, StaticStructureElement) - Method in class com.structurizr.view.DynamicView
add(CustomElement, String, String, CustomElement) - Method in class com.structurizr.view.DynamicView
add(CustomElement, String, String, StaticStructureElement) - Method in class com.structurizr.view.DynamicView
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(InfrastructureNode) - Method in class com.structurizr.view.DeploymentView: Adds an infrastructure node (and its parent deployment nodes) to this view.
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.CustomView: Adds a specific relationship 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.DynamicView: Adds a specific relationship to this dynamic view, with the original description.
add(Relationship) - Method in class com.structurizr.view.StaticView: Adds a specific relationship to this view.
add(Relationship, String) - Method in class com.structurizr.view.DynamicView: Adds a specific relationship to this dynamic view, with an overidden description.
add(SoftwareSystem) - Method in class com.structurizr.model.DeploymentNode: Adds a software system instance to this deployment node, replicating relationships.
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(SoftwareSystemInstance) - Method in class com.structurizr.view.DeploymentView: Adds a software system instance (and its parent deployment nodes) to this view.
add(SoftwareSystem, boolean) - Method in class com.structurizr.view.StaticView: Adds the given software system to this view.
add(SoftwareSystem, String...) - Method in class com.structurizr.model.DeploymentNode: Adds a software system instance to this deployment node, replicating relationships.
add(StaticStructureElement, CustomElement) - Method in class com.structurizr.view.DynamicView
add(StaticStructureElement, StaticStructureElement) - Method in class com.structurizr.view.DynamicView
add(StaticStructureElement, String, CustomElement) - Method in class com.structurizr.view.DynamicView
add(StaticStructureElement, String, StaticStructureElement) - Method in class com.structurizr.view.DynamicView
add(StaticStructureElement, String, String, CustomElement) - Method in class com.structurizr.view.DynamicView
add(StaticStructureElement, String, String, StaticStructureElement) - Method in class com.structurizr.view.DynamicView
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.
addAllCustomElements() - Method in class com.structurizr.view.CustomView: Adds all custom elements to this view.
addAllDeploymentNodes() - Method in class com.structurizr.view.DeploymentView: Adds all of the top-level deployment nodes to this view, for the same deployment environment (if set).
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(CustomElement...) - Method in class com.structurizr.view.CustomView: Adds an animation step, with the specified elements.
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.
addAnimation(StaticStructureElementInstance...) - Method in class com.structurizr.view.DeploymentView: Adds an animation step, with the specified element instances.
addAnimation(StaticStructureElementInstance[], InfrastructureNode[]) - Method in class com.structurizr.view.DeploymentView: Adds an animation step, with the specified container instances and infrastructure nodes.
addComponent(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.
addContainer(String) - Method in class com.structurizr.model.SoftwareSystem: Adds a container with the specified name.
addContainer(String, String) - Method in class com.structurizr.model.SoftwareSystem: Adds a container with the specified name and description.
addContainer(String, String, String) - Method in class com.structurizr.model.SoftwareSystem: Adds a container with the specified name, description and technology.
addCustomElement(String) - Method in class com.structurizr.model.Model: Creates a custom element and adds it to the model.
addCustomElement(String, String, String) - Method in class com.structurizr.model.Model: Creates a custom element and adds it to the model.
addDecision(Decision) - Method in class com.structurizr.documentation.Documentation: Adds a new decision to this documentation.
addDefaultElements() - Method in class com.structurizr.view.ComponentView: Adds the default set of elements to this view.
addDefaultElements() - Method in class com.structurizr.view.ContainerView: Adds the default set of elements to this view.
addDefaultElements() - Method in class com.structurizr.view.CustomView: Adds the default set of elements to this view.
addDefaultElements() - Method in class com.structurizr.view.DeploymentView: Adds the default set of elements to this view.
addDefaultElements() - Method in class com.structurizr.view.StaticView: Adds the default set of elements to this view.
addDefaultElements() - Method in class com.structurizr.view.SystemContextView: Adds the default set of elements to this view.
addDefaultElements() - Method in class com.structurizr.view.SystemLandscapeView: Adds the default set of elements to this view.
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.
addElement(Element, boolean) - Method in class com.structurizr.view.ModelView
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.
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.StaticStructureElementInstance: 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.StaticStructureElementInstance: Adds a new health check.
addImage(Image) - Method in class com.structurizr.documentation.Documentation: Adds an image to the documentation.
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.
addLink(Decision, String) - Method in class com.structurizr.documentation.Decision: Adds a link between this decision and another.
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.ModelView
addPerson(Location, String, String) - Method in class com.structurizr.model.Model: Creates a person and adds it to the model.
addPerson(String) - Method in class com.structurizr.model.Model: Creates a person (with an unspecified location) 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.
addPerspective(String, String) - Method in class com.structurizr.model.ModelItem: Adds a perspective to this model item.
addProperty(String, String) - Method in class com.structurizr.AbstractWorkspace: Adds a name-value pair property to this workspace.
addProperty(String, String) - Method in class com.structurizr.model.ModelItem: Adds a name-value pair property to this model item.
addProperty(String, String) - Method in interface com.structurizr.PropertyHolder: Adds a name-value pair property to this workspace.
addProperty(String, String) - Method in class com.structurizr.view.AbstractStyle: Adds a name-value pair property to this workspace.
addProperty(String, String) - Method in class com.structurizr.view.Configuration: Adds a name-value pair property.
addProperty(String, String) - Method in class com.structurizr.view.View: Adds a name-value pair property to this view.
addRelationship(Relationship) - Method in class com.structurizr.view.ModelView
addRelationship(Relationship, String, String, boolean) - Method in class com.structurizr.view.DynamicView
addRelationshipStyle(String) - Method in class com.structurizr.view.Styles
addSection(Section) - Method in class com.structurizr.documentation.Documentation: Adds a section to this documentation.
addSoftwareSystem(Location, String, String) - Method in class com.structurizr.model.Model: Creates a software system and adds it to the model.
addSoftwareSystem(String) - Method in class com.structurizr.model.Model: Creates a software system (with an unspecified location) 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.
addStylesFromTheme(Theme) - Method in class com.structurizr.view.Styles: Adds the element/relationship styles from the given theme.
addTags(String...) - Method in class com.structurizr.model.ModelItem
addTheme(String) - Method in class com.structurizr.view.Configuration: Adds a theme.
addUser(String, Role) - Method in class com.structurizr.configuration.WorkspaceConfiguration: Adds a user, with the specified username and role.
AngleBrackets - Enum constant in enum class com.structurizr.view.MetadataSymbols
Animation - Class in com.structurizr.view: A wrapper for a collection of animation steps.
AsciiDoc - Enum constant in enum class com.structurizr.documentation.Format
Asynchronous - Enum constant in enum class com.structurizr.model.InteractionStyle: Denotes asynchronous communication.
ASYNCHRONOUS - Static variable in class com.structurizr.model.Tags: To be used for styling of asynchronous relationships
AutomaticLayout - Class in com.structurizr.view: A wrapper for automatic layout configuration.
AutomaticLayout.Implementation - Enum Class in com.structurizr.view
AutomaticLayout.RankDirection - Enum Class 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 Class in com.structurizr.view
BottomTop - Enum constant in enum class com.structurizr.view.AutomaticLayout.RankDirection
Box - Enum constant in enum class 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.CustomView
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.ModelView
canBeRemoved(Element) - Method in class com.structurizr.view.SystemContextView
canBeRemoved(Element) - Method in class com.structurizr.view.SystemLandscapeView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.ComponentView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.ContainerView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.CustomView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.DeploymentView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.DynamicView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.ModelView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.SystemContextView
checkElementCanBeAdded(Element) - Method in class com.structurizr.view.SystemLandscapeView
Circle - Enum constant in enum class 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.
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
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 - Enum constant in enum class 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.
CONTENT_TYPE_IMAGE_JPG - Static variable in class com.structurizr.util.ImageUtils
CONTENT_TYPE_IMAGE_PNG - Static variable in class com.structurizr.util.ImageUtils
CONTENT_TYPE_IMAGE_SVG - Static variable in class com.structurizr.util.ImageUtils
copyConfigurationFrom(Configuration) - Method in class com.structurizr.view.Configuration
copyLayoutInformation(ModelView, ModelView) - Method in class com.structurizr.view.DefaultLayoutMergeStrategy: Attempts to copy the visual layout information (e.g.
copyLayoutInformation(ModelView, ModelView) - 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.
createCustomView(String, String, String) - Method in class com.structurizr.view.ViewSet: Creates a custom view view.
createDefaultViews() - Method in class com.structurizr.view.ViewSet
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.
createImageView(Element, String) - Method in class com.structurizr.view.ViewSet: Creates an image view, where the scope is the specified element.
createImageView(String) - Method in class com.structurizr.view.ViewSet: Creates an image view.
createImpliedRelationship(Relationship, Element, Element) - Method in class com.structurizr.model.AbstractImpliedRelationshipsStrategy: Creates an implied relationship based upon the specified relationship, between the specified source and destination elements.
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 - Enum constant in enum class com.structurizr.view.MetadataSymbols
Curved - Enum constant in enum class com.structurizr.view.Routing
CustomElement - Class in com.structurizr.model: Represents a custom element.
CustomElement() - Constructor for class com.structurizr.model.CustomElement
CustomView - Class in com.structurizr.view: Represents a custom view, containing custom elements.
Cylinder - Enum constant in enum class com.structurizr.view.Shape

D

Dagre - Enum constant in enum class com.structurizr.view.AutomaticLayout.Implementation
dashed(boolean) - Method in class com.structurizr.view.RelationshipStyle
Dashed - Enum constant in enum class com.structurizr.view.Border
Dashed - Enum constant in enum class com.structurizr.view.LineStyle
DATA_URI_IMAGE_JPG - Static variable in class com.structurizr.util.ImageUtils
DATA_URI_IMAGE_PNG - Static variable in class com.structurizr.util.ImageUtils
DATA_URI_IMAGE_SVG - Static variable in class com.structurizr.util.ImageUtils
DATA_URI_PREFIX - Static variable in class com.structurizr.util.ImageUtils
Decision - Class in com.structurizr.documentation: Represents a single (architecture) decision, as described at http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
Decision(String) - Constructor for class com.structurizr.documentation.Decision
Decision.Link - Class in com.structurizr.documentation: Represents a link between two decisions.
Default - Enum constant in enum class com.structurizr.view.ViewSortOrder
DEFAULT_DEPLOYMENT_ENVIRONMENT - Static variable in class com.structurizr.model.DeploymentElement
DEFAULT_DEPLOYMENT_GROUP - Static variable in class com.structurizr.model.DeploymentElement
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.
delivers(Person, String, String, InteractionStyle, String[]) - 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.
description(boolean) - Method in class com.structurizr.view.ElementStyle
Diamond - Enum constant in enum class com.structurizr.view.Shape
Dimensions - Class in com.structurizr.view
Dimensions(int, int) - Constructor for class com.structurizr.view.Dimensions
Direct - Enum constant in enum class com.structurizr.view.Routing
disableAutomaticLayout() - Method in class com.structurizr.view.ModelView: Disables automatic layout for this view.
Documentable - Interface in com.structurizr.documentation: Marker interface for items that can have documentation attached (i.e.
Documentation - Class in com.structurizr.documentation: Represents the documentation within a workspace or software system - a collection of content in Markdown or AsciiDoc format, optionally with attached images.
Documentation() - Constructor for class com.structurizr.documentation.Documentation
DocumentationContent - Class in com.structurizr.documentation: Represents a piece of documentation content ...
Dotted - Enum constant in enum class com.structurizr.view.Border
Dotted - Enum constant in enum class com.structurizr.view.LineStyle
DoubleAngleBrackets - Enum constant in enum class 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
ElementNotPermittedInViewException - Exception in com.structurizr.view
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 - Enum constant in enum class com.structurizr.view.Shape
enableAutomaticLayout() - Method in class com.structurizr.view.ModelView: Enables automatic layout for this view, with some default settings.
enableAutomaticLayout(AutomaticLayout.RankDirection) - Method in class com.structurizr.view.ModelView: Enables automatic layout for this view, with the specified direction, using the Graphviz implementation.
enableAutomaticLayout(AutomaticLayout.RankDirection, int, int) - Method in class com.structurizr.view.ModelView: 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.ModelView: 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.Decision
equals(Object) - Method in class com.structurizr.documentation.Decision.Link
equals(Object) - Method in class com.structurizr.documentation.Section
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 - Enum constant in enum class com.structurizr.view.FilterMode
External - Enum constant in enum class 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 Class in com.structurizr.view
findElementStyle(Element) - Method in class com.structurizr.view.Styles: Finds the element style used to render the specified element, according to the following rules: 1.
findElementStyle(String) - Method in class com.structurizr.view.Styles: Finds the element style for the given tag.
findElementView(ModelView, Element) - Method in class com.structurizr.view.DefaultLayoutMergeStrategy: Finds an element.
findFontFromThemes() - Method in class com.structurizr.view.Styles
findLogoFromThemes() - Method in class com.structurizr.view.Styles
findRelationshipStyle(Relationship) - Method in class com.structurizr.view.Styles: Finds the relationship style used to render the specified relationship, according to the following rules: 1.
findRelationshipStyle(String) - Method in class com.structurizr.view.Styles: Finds the relationship style for the given tag.
findTerminology(ModelItem) - Method in class com.structurizr.view.Terminology: Finds the terminology that can be used to describe/label the specified model item.
Folder - Enum constant in enum class 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 Class 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.SequentialIntegerIdGeneratorStrategy
fromColorNameToHexColorCode(String) - Static method in class com.structurizr.view.Color

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.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.SequentialIntegerIdGeneratorStrategy
getAnimations() - Method in class com.structurizr.view.CustomView
getAnimations() - Method in class com.structurizr.view.DeploymentView
getAnimations() - Method in class com.structurizr.view.StaticView
getAutomaticLayout() - Method in class com.structurizr.view.ModelView: Gets the automatic layout settings for this view.
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.CustomElement
getCanonicalName() - Method in class com.structurizr.model.DeploymentNode
getCanonicalName() - Method in class com.structurizr.model.InfrastructureNode
getCanonicalName() - Method in class com.structurizr.model.ModelItem
getCanonicalName() - Method in class com.structurizr.model.Person
getCanonicalName() - Method in class com.structurizr.model.Relationship
getCanonicalName() - Method in class com.structurizr.model.SoftwareSystem: Gets the canonical name of this software system, in the form "/Software System".
getCanonicalName() - Method in class com.structurizr.model.SoftwareSystemInstance
getChildren() - Method in class com.structurizr.model.DeploymentNode: Gets the set of child deployment nodes.
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
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.DocumentationContent: Gets the content.
getContent() - Method in class com.structurizr.documentation.Image
getContent() - Method in class com.structurizr.view.ImageView: Gets the content of this view (a URL or a data URI).
getContentType() - Method in class com.structurizr.view.ImageView: Gets the the content type of this view (e.g.
getContentType(File) - Static method in class com.structurizr.util.ImageUtils: Gets the content type of the specified file representing an image.
getContentType(String) - Static method in class com.structurizr.util.ImageUtils: Gets the content type of the specified URL representing an image.
getContentTypeFromDataUri(String) - Static method in class com.structurizr.util.ImageUtils: Gets the content type of the specified data URI representing an image.
getCustomElements() - Method in class com.structurizr.model.Model: Gets the set of all custom elements in this model.
getCustomElementWithName(String) - Method in class com.structurizr.model.Model: Gets the custom element with the specified name.
getCustomViews() - Method in class com.structurizr.view.ViewSet: Gets the set of custom views.
getDashed() - Method in class com.structurizr.view.RelationshipStyle
getDate() - Method in class com.structurizr.documentation.Decision: Gets the date of this decision.
getDecisions() - Method in class com.structurizr.documentation.Documentation: Gets the set of decisions associated with this workspace.
getDefaultTags() - Method in class com.structurizr.model.Component
getDefaultTags() - Method in class com.structurizr.model.Container
getDefaultTags() - Method in class com.structurizr.model.CustomElement
getDefaultTags() - Method in class com.structurizr.model.DeploymentNode
getDefaultTags() - Method in class com.structurizr.model.InfrastructureNode
getDefaultTags() - Method in class com.structurizr.model.ModelItem
getDefaultTags() - Method in class com.structurizr.model.Person
getDefaultTags() - Method in class com.structurizr.model.Relationship
getDefaultTags() - Method in class com.structurizr.model.SoftwareSystem
getDefaultTags() - Method in class com.structurizr.model.StaticStructureElementInstance
getDefaultView() - Method in class com.structurizr.view.Configuration: Gets the key of the view that should be shown by default.
getDeploymentGroups() - Method in class com.structurizr.model.StaticStructureElementInstance: Gets the deployment group of this element instance.
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 deployment views.
getDescription() - Method in class com.structurizr.AbstractWorkspace: Gets the description of this workspace.
getDescription() - Method in class com.structurizr.documentation.Decision.Link: Gets the description of this link.
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.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.
getDimensions() - Method in class com.structurizr.view.ModelView
getDocumentation() - Method in interface com.structurizr.documentation.Documentable
getDocumentation() - Method in class com.structurizr.model.Container: Gets the documentation associated with this container.
getDocumentation() - Method in class com.structurizr.model.SoftwareSystem: Gets the documentation associated with this software system.
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: Gets the efferent (outgoing) relationship with the specified element and description.
getElement() - Method in class com.structurizr.model.ContainerInstance
getElement() - Method in class com.structurizr.model.SoftwareSystemInstance
getElement() - Method in class com.structurizr.model.StaticStructureElementInstance
getElement() - Method in class com.structurizr.view.DynamicView
getElement() - Method in class com.structurizr.view.ElementView
getElement() - Method in class com.structurizr.view.ImageView
getElement(String) - Method in class com.structurizr.model.Model: Gets the element with the specified ID.
getElementId() - Method in class com.structurizr.documentation.DocumentationContent: Gets the ID of the element that this documentation content is associated with.
getElementId() - Method in class com.structurizr.view.DynamicView: Gets the ID of the software system or container associated with this view.
getElementId() - Method in class com.structurizr.view.ImageView: Gets the ID of the element 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.Animation
getElements() - Method in class com.structurizr.view.ModelView: Gets the set of elements in this view.
getElements() - Method in class com.structurizr.view.Styles
getElementStyle(String) - Method in class com.structurizr.view.Styles: Gets the element style that has been defined (in this workspace) for the given tag.
getElementView(Element) - Method in class com.structurizr.view.ModelView: 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.
getExternalBoundariesVisible() - Method in class com.structurizr.view.DynamicView: Determines whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).
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).
getFilename() - Method in class com.structurizr.documentation.Section: Gets the filename of this section.
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
getFormat() - Method in class com.structurizr.documentation.DocumentationContent: Gets the format of this content.
getGroup() - Method in class com.structurizr.model.GroupableElement: Gets the name of the group in which this element should be included in.
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.StaticStructureElementInstance: Gets the set of health checks associated with this element instance.
getHeight() - Method in class com.structurizr.view.Dimensions
getHeight() - Method in class com.structurizr.view.ElementStyle: Gets the height of the element, in pixels.
getHeight() - Method in enum class 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: Gets the ID of this decision.
getId() - Method in class com.structurizr.documentation.Decision.Link
getId() - Method in class com.structurizr.model.ModelItem: Gets the ID of this item in the model.
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.
getImageViews() - Method in class com.structurizr.view.ViewSet: Gets the set of image views.
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.
getInstanceId() - Method in class com.structurizr.model.StaticStructureElementInstance: Gets the instance ID of this element instance.
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.View: Gets the identifier for this view.
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
getLinks() - Method in class com.structurizr.documentation.Decision: Gets the set of links from this decision.
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
getMergeFromRemote() - Method in class com.structurizr.view.ModelView: Gets whether layout information for this view should be merged from a remote version of the workspace.
getMetadata() - Method in class com.structurizr.model.CustomElement
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.model.Relationship
getModel() - Method in class com.structurizr.view.CustomView: Gets the model that this view belongs to.
getModel() - Method in class com.structurizr.view.DeploymentView
getModel() - Method in class com.structurizr.view.DynamicView
getModel() - Method in class com.structurizr.view.ModelView: Gets the model that this view belongs to.
getModel() - Method in class com.structurizr.view.SystemLandscapeView: 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.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.model.StaticStructureElementInstance
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.CustomView: 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.FilteredView
getName() - Method in class com.structurizr.view.Font
getName() - Method in class com.structurizr.view.ImageView
getName() - Method in enum class 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.Animation
getOrder() - Method in class com.structurizr.view.RelationshipView: Gets the order of this relationship (used in dynamic views only; e.g.
getOrder() - Method in class com.structurizr.view.View: Gets the order of this view.
getOrderedPaperSizes() - Static method in enum class com.structurizr.view.PaperSize
getOrderedPaperSizes(PaperSize.Orientation) - Static method in enum class com.structurizr.view.PaperSize
getOrientation() - Method in enum class com.structurizr.view.PaperSize
getPaperSize() - Method in class com.structurizr.view.ModelView: 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.CustomElement
getParent() - Method in class com.structurizr.model.DeploymentElement: 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.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.
getPerspectives() - Method in class com.structurizr.model.ModelItem: Gets the set of perspectives associated with this model item.
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.
getProperties() - Method in class com.structurizr.AbstractWorkspace: Gets the collection of name-value property pairs associated with this workspace, as a Map.
getProperties() - Method in class com.structurizr.model.ModelItem: Gets the collection of name-value property pairs associated with this model item, as a Map.
getProperties() - Method in interface com.structurizr.PropertyHolder: Gets the collection of name-value property pairs associated with this workspace, as a Map.
getProperties() - Method in class com.structurizr.view.AbstractStyle: Gets the collection of name-value property pairs associated with this workspace, as a Map.
getProperties() - Method in class com.structurizr.view.Configuration: Gets the collection of name-value property pairs, as a Map.
getProperties() - Method in class com.structurizr.view.View: Gets the collection of name-value property pairs associated with this view, as a Map.
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.Animation
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.ModelView: Gets the set of relationships in this view.
getRelationships() - Method in class com.structurizr.view.Styles
getRelationshipStyle(String) - Method in class com.structurizr.view.Styles: Gets the relationship style that has been defined (in this workspace) for the given tag.
getRelationshipView(Relationship) - Method in class com.structurizr.view.ModelView: Gets the relationship view for the given relationship.
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.
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.
getSoftwareSystem() - Method in class com.structurizr.model.Container: Gets the parent software system.
getSoftwareSystem() - Method in class com.structurizr.model.SoftwareSystemInstance
getSoftwareSystem() - Method in class com.structurizr.view.ModelView: Gets the software system that this view is associated with.
getSoftwareSystem() - Method in class com.structurizr.view.Terminology
getSoftwareSystemId() - Method in class com.structurizr.model.SoftwareSystemInstance: Gets the ID of the software system that this object represents a deployment instance of.
getSoftwareSystemId() - Method in class com.structurizr.view.ComponentView
getSoftwareSystemId() - Method in class com.structurizr.view.DynamicView
getSoftwareSystemId() - Method in class com.structurizr.view.ModelView: Gets the ID of the software system this view is associated with.
getSoftwareSystemInstances() - Method in class com.structurizr.model.DeploymentNode: Gets the set of software system instances associated with this deployment node.
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: Gets the status of this decision.
getStroke() - Method in class com.structurizr.view.ElementStyle: Gets the stroke colour of the element, as a HTML RGB hex string (e.g.
getStrokeWidth() - Method in class com.structurizr.view.ElementStyle: Gets the stroke width, in pixels, between 1 and 10.
getStyle() - Method in class com.structurizr.view.RelationshipStyle
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.model.ModelItem: Gets the comma separated list of tags.
getTags() - Method in class com.structurizr.view.FilteredView
getTagsAsSet() - Method in class com.structurizr.model.ModelItem
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.
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.DocumentationContent: Gets the title.
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
getUrl() - Method in class com.structurizr.model.HttpHealthCheck: Gets the URL for this health check.
getUrl() - Method in class com.structurizr.model.ModelItem: Gets the URL where more information about this item 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.
getViews() - Method in class com.structurizr.Workspace: Gets the set of views onto a software architecture model.
getViewSet() - Method in class com.structurizr.view.ModelView: Gets the view set that this view belongs to.
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.
getViewWithKey(String) - Method in class com.structurizr.view.ViewSet: Finds the view with the specified key, or null if the view does not exist.
getWidth() - Method in class com.structurizr.view.Dimensions
getWidth() - Method in class com.structurizr.view.ElementStyle: Gets the width of the element, in pixels.
getWidth() - Method in enum class 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 - Enum constant in enum class com.structurizr.view.AutomaticLayout.Implementation
GroupableElement - Class in com.structurizr.model: Represents an element that can be included in a group.

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.Decision
hashCode() - Method in class com.structurizr.documentation.Decision.Link
hashCode() - Method in class com.structurizr.documentation.Section
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
hasLinkTo(Decision) - Method in class com.structurizr.documentation.Decision: Determines whether a decision already has a link to another decision
hasTag(String) - Method in class com.structurizr.model.ModelItem: Determines whether this model item has the given tag.
height(int) - Method in class com.structurizr.view.ElementStyle
Hexagon - Enum constant in enum class 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/relationships, must implement.
Image - Class in com.structurizr.documentation: Represents a base64 encoded image (png/jpg/gif).
Image(String, String, String) - Constructor for class com.structurizr.documentation.Image
ImageUtils - Class in com.structurizr.util: Some utility methods for dealing with images.
ImageUtils() - Constructor for class com.structurizr.util.ImageUtils
ImageView - Class in com.structurizr.view: A view that has been rendered elsewhere (e.g.
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 - Enum constant in enum class 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 Class 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 - Enum constant in enum class com.structurizr.model.Location
isElementInView(Element) - Method in class com.structurizr.view.ModelView
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
isResponse() - Method in class com.structurizr.view.RelationshipView: Gets whether this relationship view represents a response (used in dynamic views only).
isSupportedDataUri(String) - Static method in class com.structurizr.util.ImageUtils
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 - Enum constant in enum class com.structurizr.view.ViewSortOrder

L

Landscape - Enum constant in enum class 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 - Enum constant in enum class com.structurizr.view.AutomaticLayout.RankDirection
Legal_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
Legal_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
Letter_Landscape - Enum constant in enum class com.structurizr.view.PaperSize
Letter_Portrait - Enum constant in enum class com.structurizr.view.PaperSize
LineStyle - Enum Class in com.structurizr.view
Location - Enum Class 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 - Enum constant in enum class com.structurizr.documentation.Format
metadata(boolean) - Method in class com.structurizr.view.ElementStyle
MetadataSymbols - Enum Class in com.structurizr.view: The type of symbols to use when rendering metadata.
MobileDeviceLandscape - Enum constant in enum class com.structurizr.view.Shape
MobileDevicePortrait - Enum constant in enum class com.structurizr.view.Shape
Model - Class in com.structurizr.model: Represents a software architecture model, into which all model elements are added.
ModelItem - Class in com.structurizr.model: The base class for elements and relationships.
ModelItem() - Constructor for class com.structurizr.model.ModelItem
ModelView - Class in com.structurizr.view: The superclass for all views that show elements/relationships from the model, namely: - System landscape views - System context views - Container views - Dynamic views - Deployment views
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 - Enum constant in enum class com.structurizr.view.MetadataSymbols

O

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

P

PaperSize - Enum Class in com.structurizr.view: These represent paper sizes in pixels at 300dpi.
PaperSize.Orientation - Enum Class in com.structurizr.view
Person - Class in com.structurizr.model: Represents a "person" in the C4 model.
Person - Enum constant in enum class 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 - Enum constant in enum class com.structurizr.view.Shape
Portrait - Enum constant in enum class com.structurizr.view.PaperSize.Orientation
position(int) - Method in class com.structurizr.view.RelationshipStyle
PropertyHolder - Interface in com.structurizr

R

ReadOnly - Enum constant in enum class com.structurizr.configuration.Role
ReadWrite - Enum constant in enum class com.structurizr.configuration.Role
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
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(ContainerInstance) - Method in class com.structurizr.view.DeploymentView: Removes a container instance from this view.
remove(CustomElement) - Method in class com.structurizr.view.CustomView: Removes the given custom element from this view.
remove(CustomElement) - Method in class com.structurizr.view.DeploymentView: Removes the given custom element from this view.
remove(CustomElement) - Method in class com.structurizr.view.StaticView: Removes the given custom element from this view.
remove(DeploymentNode) - Method in class com.structurizr.view.DeploymentView: Removes the given deployment node from this view.
remove(InfrastructureNode) - Method in class com.structurizr.view.DeploymentView: Removes an infrastructure node 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.ModelView: Removes a relationship from this view.
remove(SoftwareSystem) - Method in class com.structurizr.view.StaticView: Removes the given software system from this view.
remove(SoftwareSystemInstance) - Method in class com.structurizr.view.DeploymentView: Removes a software system instance from this view.
removeElement(Element) - Method in class com.structurizr.view.ModelView
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.ModelView: 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.ModelView: 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.ModelItem: Removes the given tag.
removeTag(String) - Method in class com.structurizr.model.StaticStructureElementInstance
RightLeft - Enum constant in enum class com.structurizr.view.AutomaticLayout.RankDirection
Robot - Enum constant in enum class com.structurizr.view.Shape
Role - Enum Class in com.structurizr.configuration: Represents the access that a user has to a workspace.
RoundBrackets - Enum constant in enum class com.structurizr.view.MetadataSymbols
RoundedBox - Enum constant in enum class com.structurizr.view.Shape
routing(Routing) - Method in class com.structurizr.view.RelationshipStyle
Routing - Enum Class in com.structurizr.view

S

Section - Class in com.structurizr.documentation: A documentation section.
Section() - Constructor for class com.structurizr.documentation.Section
Section(String, Format, String) - Constructor for class com.structurizr.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.ElementStyle
setBorder(Border) - Method in class com.structurizr.view.ElementStyle
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
setContent(String) - Method in class com.structurizr.documentation.DocumentationContent
setContent(String) - Method in class com.structurizr.view.ImageView: Sets the content of this image view, which needs to be a URL or a data URI.
setContentType(String) - Method in class com.structurizr.view.ImageView: Sets the content type of this view (e.g.
setDashed(Boolean) - Method in class com.structurizr.view.RelationshipStyle
setDate(Date) - Method in class com.structurizr.documentation.Decision
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.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
setDimensions(Dimensions) - Method in class com.structurizr.view.ModelView
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.
setExternalBoundariesVisible(boolean) - Method in class com.structurizr.view.DynamicView: Sets whether software system/container boundaries should be visible for "external" containers/components (those outside the element in scope).
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).
setFilename(String) - Method in class com.structurizr.documentation.Section: Sets the filename of this section (e.g.
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
setFormat(Format) - Method in class com.structurizr.documentation.DocumentationContent
setGroup(String) - Method in class com.structurizr.model.GroupableElement: Sets the name of the group in which this element should be included in.
setHeight(int) - Method in class com.structurizr.view.Dimensions
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
setInstances(String) - Method in class com.structurizr.model.DeploymentNode
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.ModelView: 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.
setMergeFromRemote(boolean) - Method in class com.structurizr.view.ModelView: Specifies whether layout information for this view should be merged from a remote version of the workspace.
setMetadata(Boolean) - Method in class com.structurizr.view.ElementStyle: Sets whether the element metadata should be shown or not.
setMetadata(String) - Method in class com.structurizr.model.CustomElement
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
setModel(Model) - Method in class com.structurizr.model.Relationship
setName(String) - Method in class com.structurizr.AbstractWorkspace: Sets the name of this workspace.
setName(String) - Method in class com.structurizr.model.StaticStructureElementInstance
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(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.ModelView
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
setSoftwareSystem(String) - Method in class com.structurizr.view.Terminology
setStatus(String) - Method in class com.structurizr.documentation.Decision
setStroke(String) - Method in class com.structurizr.view.ElementStyle
setStrokeWidth(Integer) - Method in class com.structurizr.view.ElementStyle
setStyle(LineStyle) - Method in class com.structurizr.view.RelationshipStyle
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
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.documentation.DocumentationContent
setTitle(String) - Method in class com.structurizr.view.View: Sets the title for this view.
setUrl(String) - Method in class com.structurizr.model.ModelItem: Sets the URL where more information about this item 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.
setWidth(int) - Method in class com.structurizr.view.Dimensions
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 Class in com.structurizr.view
Slide_16_10 - Enum constant in enum class com.structurizr.view.PaperSize
Slide_16_9 - Enum constant in enum class com.structurizr.view.PaperSize
Slide_4_3 - Enum constant in enum class com.structurizr.view.PaperSize
SOFTWARE_SYSTEM - Static variable in class com.structurizr.model.Tags
SOFTWARE_SYSTEM_INSTANCE - Static variable in class com.structurizr.model.Tags
SoftwareSystem - Class in com.structurizr.model: Represents a "software system" in the C4 model.
SoftwareSystemInstance - Class in com.structurizr.model: Represents a deployment instance of a SoftwareSystem, which can be added to a DeploymentNode.
Solid - Enum constant in enum class com.structurizr.view.Border
Solid - Enum constant in enum class com.structurizr.view.LineStyle
SquareBrackets - Enum constant in enum class 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.
StaticStructureElementInstance - Class in com.structurizr.model: Represents a deployment instance of a SoftwareSystem or Container, which can be added to a DeploymentNode.
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
strokeWidth(Integer) - Method in class com.structurizr.view.ElementStyle
style(LineStyle) - Method in class com.structurizr.view.RelationshipStyle
Styles - Class in com.structurizr.view
Styles() - Constructor for class com.structurizr.view.Styles
Synchronous - Enum constant in enum class 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
TagUtils - Class in com.structurizr.util
TagUtils() - Constructor for class com.structurizr.util.TagUtils
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 - Enum constant in enum class 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
toString(Collection<String>) - Static method in class com.structurizr.util.TagUtils
Type - Enum constant in enum class com.structurizr.view.ViewSortOrder

U

Unspecified - Enum constant in enum class 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(Component, String, String, InteractionStyle, String[]) - 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(Container, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and a container.
uses(CustomElement, String) - Method in class com.structurizr.model.Element: Adds a unidirectional "uses" style relationship between this element and the specified custom element.
uses(CustomElement, String, String) - Method in class com.structurizr.model.Element: Adds a unidirectional "uses" style relationship between this element and the specified custom element.
uses(CustomElement, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.Element: Adds a unidirectional "uses" style relationship between this element and the specified custom element.
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(DeploymentElement, String, String, InteractionStyle, 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(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(DeploymentNode, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.DeploymentNode: Adds a relationship between this and another deployment node.
uses(Element, String) - Method in class com.structurizr.model.CustomElement: Adds a unidirectional "uses" style relationship between this custom element and the specified element.
uses(Element, String, String) - Method in class com.structurizr.model.CustomElement: Adds a unidirectional "uses" style relationship between this custom element and the specified element.
uses(Element, String, String, InteractionStyle) - Method in class com.structurizr.model.CustomElement: Adds a unidirectional "uses" style relationship between this custom element and the specified element.
uses(Element, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.CustomElement: Adds a unidirectional "uses" style relationship between this custom element and the specified element.
uses(InfrastructureNode, String, String) - Method in class com.structurizr.model.DeploymentNode: Adds a relationship between this deployment node and an infrastructure node.
uses(InfrastructureNode, String, String) - Method in class com.structurizr.model.StaticStructureElementInstance: Adds a relationship between this element instance and an infrastructure node.
uses(InfrastructureNode, String, String, InteractionStyle) - Method in class com.structurizr.model.DeploymentNode: Adds a relationship between this deployment node and an infrastructure node.
uses(InfrastructureNode, String, String, InteractionStyle) - Method in class com.structurizr.model.StaticStructureElementInstance: Adds a relationship between this element instance and an infrastructure node.
uses(InfrastructureNode, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.DeploymentNode: Adds a relationship between this deployment node and an infrastructure node.
uses(InfrastructureNode, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.StaticStructureElementInstance: Adds a relationship between this element instance and an infrastructure 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(SoftwareSystem, String, String, InteractionStyle, String[]) - 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.
uses(StaticStructureElement, String, String, InteractionStyle, String[]) - Method in class com.structurizr.model.StaticStructureElement: Adds a unidirectional "uses" style relationship between this element and the specified element.

V

validateImage(String) - Static method in class com.structurizr.util.ImageUtils
valueOf(String) - Static method in enum class com.structurizr.configuration.Role: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.documentation.Format: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.model.InteractionStyle: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.model.Location: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.AutomaticLayout.Implementation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.AutomaticLayout.RankDirection: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.Border: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.FilterMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.LineStyle: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.MetadataSymbols: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.PaperSize.Orientation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.PaperSize: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.Routing: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.Shape: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.structurizr.view.ViewSortOrder: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.structurizr.configuration.Role: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.documentation.Format: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.model.InteractionStyle: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.model.Location: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.AutomaticLayout.Implementation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.AutomaticLayout.RankDirection: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.Border: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.FilterMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.LineStyle: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.MetadataSymbols: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.PaperSize.Orientation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.PaperSize: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.Routing: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.Shape: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.structurizr.view.ViewSortOrder: Returns an array containing the constants of this enum class, 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.
ViewSet - Class in com.structurizr.view: A set of views onto a software architecture model.
ViewSortOrder - Enum Class in com.structurizr.view: Allows the sort order of views to be customized as follows:

W

WebBrowser - Enum constant in enum class com.structurizr.view.Shape
width(int) - Method in class com.structurizr.view.ElementStyle
width(int) - Method in class com.structurizr.view.RelationshipStyle
Window - Enum constant in enum class com.structurizr.view.Shape
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.
WORKSPACE_URL_PREFIX - Static variable in class com.structurizr.util.Url
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 and Interfaces|All Packages|Constant Field Values|Serialized Form