java.lang.Object

com.structurizr.model.SoftwareSystem

public final class SoftwareSystem
extends StaticStructureElement

Represents a "software system" in the C4 model.

Method Summary

Modifier and Type	Method	Description
`Container`	`addContainer(java.lang.String name)`	Adds a container with the specified name.
`Container`	`addContainer(java.lang.String name, java.lang.String description)`	Adds a container with the specified name and description.
`Container`	`addContainer(java.lang.String name, java.lang.String description, java.lang.String technology)`	Adds a container with the specified name, description and technology.
`java.lang.String`	`getCanonicalName()`	Gets the canonical name of this software system, in the form "/Software System".
`java.util.Set<Container>`	`getContainers()`	Gets the set of containers within this software system.
`Container`	`getContainerWithId(java.lang.String id)`	Gets the container with the specified ID.
`Container`	`getContainerWithName(java.lang.String name)`	Gets the container with the specified name.
`Location`	`getLocation()`	Gets the location of this software system.
`Element`	`getParent()`	Gets the parent of this software system.
`protected java.util.Set<java.lang.String>`	`getRequiredTags()`
`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, getOriginId, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- getParent
  
  public Element getParent()
  
  Gets the parent of this software system.
  
  Specified by:
  
  getParent in class Element
  
  Returns:
  
  null, as software systems don't have a parent element
- getLocation
  
  public Location getLocation()
  
  Gets the location of this software system.
  
  Returns:
  
  a Location instance
- setLocation
  
  public void setLocation(Location location)
  
  Sets the location of this software system.
  
  Parameters:
  
  location - a Location instance
- getContainers
  
  @Nonnull public java.util.Set<Container> getContainers()
  
  Gets the set of containers within this software system.
  
  Returns:
  
  a Set of Container objects
- addContainer
  
  @Nonnull public Container addContainer(@Nonnull java.lang.String name)
  
  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:
  
  java.lang.IllegalArgumentException - if a container with the same name exists already
- addContainer
  
  @Nonnull public Container addContainer(@Nonnull java.lang.String name, java.lang.String description)
  
  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:
  
  java.lang.IllegalArgumentException - if a container with the same name exists already
- addContainer
  
  @Nonnull public Container addContainer(@Nonnull java.lang.String name, java.lang.String description, java.lang.String technology)
  
  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 responsibilities
  
  technology - the technology choice (e.g. "Spring MVC", "Java EE", etc)
  
  Returns:
  
  the newly created Container instance added to the model (or null)
  
  Throws:
  
  java.lang.IllegalArgumentException - if a container with the same name exists already
- getContainerWithName
  
  @Nullable public Container getContainerWithName(@Nonnull java.lang.String name)
  
  Gets the container with the specified name.
  
  Parameters:
  
  name - the name of the Container
  
  Returns:
  
  the Container instance with the specified name, or null if it doesn't exist
  
  Throws:
  
  java.lang.IllegalArgumentException - if the name is null or empty
- getContainerWithId
  
  @Nullable public Container getContainerWithId(@Nonnull java.lang.String id)
  
  Gets the container with the specified ID.
  
  Parameters:
  
  id - the ModelItem.getId() of the container
  
  Returns:
  
  the Container instance with the specified ID, or null if it doesn't exist
  
  Throws:
  
  java.lang.IllegalArgumentException - if the ID is null or empty
- getCanonicalName
  
  public java.lang.String getCanonicalName()
  
  Gets the canonical name of this software system, in the form "/Software System".
  
  Specified by:
  
  getCanonicalName in class ModelItem
  
  Returns:
  
  the canonical name, as a String
- getRequiredTags
  
  protected java.util.Set<java.lang.String> getRequiredTags()
  
  Specified by:
  
  getRequiredTags in class ModelItem