Package com.structurizr.model
Class SoftwareSystem
java.lang.Object
com.structurizr.model.ModelItem
com.structurizr.model.Element
com.structurizr.model.GroupableElement
com.structurizr.model.StaticStructureElement
com.structurizr.model.SoftwareSystem
- All Implemented Interfaces:
Documentable
,PropertyHolder
Represents a "software system" in the C4 model.
-
Method Summary
Modifier and TypeMethodDescriptionaddContainer
(String name) Adds a container with the specified name.addContainer
(String name, String description) Adds a container with the specified name and description.addContainer
(String name, String description, String technology) Adds a container with the specified name, description and technology.Gets the canonical name of this software system, in the form "/Software System".Gets the set of containers within this software system.Gets the container with the specified ID.getContainerWithName
(String name) Gets the container with the specified name.Gets the documentation associated with this software system.Gets the location of this software system.Gets the parent of this software system.void
setLocation
(Location location) Sets the location of this software system.Methods inherited from class com.structurizr.model.StaticStructureElement
delivers, delivers, delivers, delivers, uses, uses, uses, uses, uses, uses, uses, uses, uses, uses, uses, uses, uses, uses
Methods inherited from class com.structurizr.model.GroupableElement
getGroup, setGroup
Methods inherited from class com.structurizr.model.Element
getDescription, getEfferentRelationshipsWith, getEfferentRelationshipWith, getEfferentRelationshipWith, getModel, getName, getRelationships, hasAfferentRelationships, hasEfferentRelationshipWith, hasEfferentRelationshipWith, setDescription, setModel, toString, uses, uses, uses
Methods inherited from class com.structurizr.model.ModelItem
addPerspective, addProperty, addTags, getId, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setUrl
-
Method Details
-
getParent
Gets the parent of this software system. -
getLocation
Gets the location of this software system.- Returns:
- a Location instance
-
setLocation
Sets the location of this software system.- Parameters:
location
- a Location instance
-
getContainers
Gets the set of containers within this software system.- Returns:
- a Set of Container objects
-
addContainer
Adds a container with the specified name.- Parameters:
name
- the name of the container (e.g. "Web Application")- Returns:
- the newly created Container instance added to the model (or null)
- Throws:
IllegalArgumentException
- if a container with the same name exists already
-
addContainer
Adds a container with the specified name and description.- Parameters:
name
- the name of the container (e.g. "Web Application")description
- a short description/list of responsibilities- Returns:
- the newly created Container instance added to the model (or null)
- Throws:
IllegalArgumentException
- if a container with the same name exists already
-
addContainer
Adds a container with the specified name, description and technology.- Parameters:
name
- the name of the container (e.g. "Web Application")description
- a short description/list of responsibilitiestechnology
- the technology choice (e.g. "Spring MVC", "Java EE", etc)- Returns:
- the newly created Container instance added to the model (or null)
- Throws:
IllegalArgumentException
- if a container with the same name exists already
-
getContainerWithName
Gets the container with the specified name.- Parameters:
name
- the name of theContainer
- Returns:
- the Container instance with the specified name, or null if it doesn't exist
- Throws:
IllegalArgumentException
- if the name is null or empty
-
getContainerWithId
Gets the container with the specified ID.- Parameters:
id
- theModelItem.getId()
of the container- Returns:
- the Container instance with the specified ID, or null if it doesn't exist
- Throws:
IllegalArgumentException
- if the ID is null or empty
-
getCanonicalName
Gets the canonical name of this software system, in the form "/Software System".- Specified by:
getCanonicalName
in classModelItem
- Returns:
- the canonical name, as a String
-
getDefaultTags
- Specified by:
getDefaultTags
in classModelItem
-
getDocumentation
Gets the documentation associated with this software system.- Specified by:
getDocumentation
in interfaceDocumentable
- Returns:
- a Documentation object
-