Index
All Classes and Interfaces|All Packages|Serialized Form
C
- com.structurizr.dsl - package com.structurizr.dsl
D
- DslUtils - Class in com.structurizr.dsl
-
Utility methods to get/set DSL on a workspace.
- DslUtils() - Constructor for class com.structurizr.dsl.DslUtils
F
- findIdentifier(Element) - Method in class com.structurizr.dsl.IdentifiersRegister
-
Finds the identifier used when defining an element.
- findIdentifier(Relationship) - Method in class com.structurizr.dsl.IdentifiersRegister
-
Finds the identifier used when defining a relationship.
G
- getDsl(Workspace) - Static method in class com.structurizr.dsl.DslUtils
-
Gets the DSL associated with a workspace.
- getDslFile() - Method in class com.structurizr.dsl.StructurizrDslPluginContext
-
Gets a reference to the DSL file that initiated this plugin context.
- getElement(String) - Method in class com.structurizr.dsl.IdentifiersRegister
-
Gets the element identified by the specified identifier.
- getElementIdentifiers() - Method in class com.structurizr.dsl.IdentifiersRegister
-
Gets the set of element identifiers.
- getIdentifiersRegister() - Method in class com.structurizr.dsl.StructurizrDslParser
-
Gets the identifier register in use (this is the mapping of DSL identifiers to elements/relationships).
- getLine() - Method in exception com.structurizr.dsl.StructurizrDslParserException
-
Gets the line associated with the parsing exception.
- getLineNumber() - Method in exception com.structurizr.dsl.StructurizrDslParserException
-
Gets the line number associated with the parsing exception.
- getParameter(String) - Method in class com.structurizr.dsl.StructurizrDslPluginContext
-
Gets the named parameter.
- getParameter(String, String) - Method in class com.structurizr.dsl.StructurizrDslPluginContext
-
Gets the named parameter, with a default value if unset.
- getRelationship(String) - Method in class com.structurizr.dsl.IdentifiersRegister
-
Gets the relationship identified by the specified identifier.
- getRelationshipIdentifiers() - Method in class com.structurizr.dsl.IdentifiersRegister
-
Gets the set of relationship identifiers.
- getWorkspace() - Method in class com.structurizr.dsl.StructurizrDslParser
-
Gets the workspace that has been created by parsing the Structurizr DSL.
- getWorkspace() - Method in class com.structurizr.dsl.StructurizrDslPluginContext
-
Gets the current workspace.
I
- IdentifiersRegister - Class in com.structurizr.dsl
-
A register of elements and relationships that were created with an identifier in the DSL.
P
- parse(File) - Method in class com.structurizr.dsl.StructurizrDslParser
-
Parses the specified Structurizr DSL file(s), adding the parsed content to the workspace.
- parse(String) - Method in class com.structurizr.dsl.StructurizrDslParser
-
Parses the specified Structurizr DSL fragment, adding the parsed content to the workspace.
R
- run(StructurizrDslPluginContext) - Method in interface com.structurizr.dsl.StructurizrDslPlugin
-
Called to execute the plugin.
S
- setDsl(Workspace, String) - Static method in class com.structurizr.dsl.DslUtils
-
Sets the DSL associated with a workspace.
- setRestricted(boolean) - Method in class com.structurizr.dsl.StructurizrDslParser
-
Sets whether to run this parser in restricted mode (this stops !include, !docs, !adrs from working).
- StructurizrDslParser - Class in com.structurizr.dsl
-
Main DSL parser class - forms the API for using the parser.
- StructurizrDslParser() - Constructor for class com.structurizr.dsl.StructurizrDslParser
-
Creates a new instance of the parser.
- StructurizrDslParserException - Exception in com.structurizr.dsl
-
Throw when there are parsing errors.
- StructurizrDslPlugin - Interface in com.structurizr.dsl
-
An interface implemented by DSL plugins.
- StructurizrDslPluginContext - Class in com.structurizr.dsl
-
Used to pass contextual information to DSL plugins when they are executed.
- StructurizrDslPluginContext(File, Workspace, Map<String, String>) - Constructor for class com.structurizr.dsl.StructurizrDslPluginContext
-
Creates a new instance.
All Classes and Interfaces|All Packages|Serialized Form