Package com.structurizr.model
Class StaticStructureElement
java.lang.Object
com.structurizr.model.ModelItem
com.structurizr.model.Element
com.structurizr.model.GroupableElement
com.structurizr.model.StaticStructureElement
- All Implemented Interfaces:
PropertyHolder
- Direct Known Subclasses:
Component
,Container
,Person
,SoftwareSystem
This is the superclass for model elements that describe the static structure
of a software system, namely Person, SoftwareSystem, Container and Component.
-
Method Summary
Modifier and TypeMethodDescriptionAdds a unidirectional relationship between this element and a person.Adds a unidirectional relationship between this element and a person.delivers
(Person destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional relationship between this element and a person.delivers
(Person destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional relationship between this element and a person.Adds a unidirectional "uses" style relationship between this element and component.Adds a unidirectional "uses" style relationship between this element and a component.uses
(Component destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and a component.uses
(Component destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and a component.Adds a unidirectional "uses" style relationship between this element and container.Adds a unidirectional "uses" style relationship between this element and a container.uses
(Container destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and a container.uses
(Container destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and a container.uses
(SoftwareSystem destination, String description) Adds a unidirectional "uses" style relationship between this element and software system.uses
(SoftwareSystem destination, String description, String technology) Adds a unidirectional "uses" style relationship between this element and a software system.uses
(SoftwareSystem destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and a software system.uses
(SoftwareSystem destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and a software system.uses
(StaticStructureElement destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and the specified element.uses
(StaticStructureElement destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and the specified element.Methods inherited from class com.structurizr.model.GroupableElement
getGroup, setGroup
Methods inherited from class com.structurizr.model.Element
getDescription, getEfferentRelationshipsWith, getEfferentRelationshipWith, getEfferentRelationshipWith, getModel, getName, getParent, getRelationships, hasAfferentRelationships, hasEfferentRelationshipWith, hasEfferentRelationshipWith, setDescription, setModel, toString, uses, uses, uses
Methods inherited from class com.structurizr.model.ModelItem
addPerspective, addProperty, addTags, getCanonicalName, getDefaultTags, getId, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setUrl
-
Method Details
-
uses
Adds a unidirectional "uses" style relationship between this element and software system.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull SoftwareSystem destination, String description, String technology) Adds a unidirectional "uses" style relationship between this element and a software system.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull SoftwareSystem destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and a software system.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull SoftwareSystem destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and a software system.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)tags
- an array of tags- Returns:
- the relationship that has just been created and added to the model
-
uses
Adds a unidirectional "uses" style relationship between this element and container.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Container destination, String description, String technology) Adds a unidirectional "uses" style relationship between this element and a container.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Container destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and a container.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Container destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and a container.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)tags
- an array of tags- Returns:
- the relationship that has just been created and added to the model
-
uses
Adds a unidirectional "uses" style relationship between this element and component.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Component destination, String description, String technology) Adds a unidirectional "uses" style relationship between this element and a component.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Component destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and a component.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Component destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and a component.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)tags
- an array of tags- Returns:
- the relationship that has just been created and added to the model
-
delivers
Adds a unidirectional relationship between this element and a person.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "sends e-mail to")- Returns:
- the relationship that has just been created and added to the model
-
delivers
@Nullable public Relationship delivers(@Nonnull Person destination, String description, String technology) Adds a unidirectional relationship between this element and a person.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "sends e-mail to")technology
- the technology details (e.g. JSON/HTTPS)- Returns:
- the relationship that has just been created and added to the model
-
delivers
@Nullable public Relationship delivers(@Nonnull Person destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional relationship between this element and a person.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "sends e-mail to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)- Returns:
- the relationship that has just been created and added to the model
-
delivers
@Nullable public Relationship delivers(@Nonnull Person destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional relationship between this element and a person.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "sends e-mail to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)tags
- an array of tags- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull StaticStructureElement destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this element and the specified element.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull StaticStructureElement destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this element and the specified element.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)tags
- an array of tags- Returns:
- the relationship that has just been created and added to the model
-