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, Comparable<ModelItem>

public final class SoftwareSystem
extends StaticStructureElement
implements Documentable

Represents a "software system" in the C4 model.

Method Summary

Modifier and Type	Method	Description
Container	addContainer(String name)	Adds a container with the specified name.
Container	addContainer(String name, String description)	Adds a container with the specified name and description.
Container	addContainer(String name, String description, String technology)	Adds a container with the specified name, description and technology.
String	getCanonicalName()	Gets the canonical name of this software system, in the form "/Software System".
Set<Container>	getContainers()	Gets the set of containers within this software system.
Container	getContainerWithId(String id)	Gets the container with the specified ID.
Container	getContainerWithName(String name)	Gets the container with the specified name.
Set<String>	getDefaultTags()
Documentation	getDocumentation()	Gets the documentation associated with this software system.
Location	getLocation()	Deprecated.
Element	getParent()	Gets the parent of this software system.
boolean	hasContainers()	Determines whether this software system has any containers.

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, addPerspective, addProperty, addTags, compareTo, getId, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setId, 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

@Deprecated
public Location getLocation()

Deprecated.

getContainers

@Nonnull
public Set<Container> getContainers()

Gets the set of containers within this software system.

Returns:

a Set of Container objects

hasContainers

public boolean hasContainers()

Determines whether this software system has any containers.

Returns:

true if it has containers, false otherwise

addContainer

@Nonnull
public Container addContainer(@Nonnull
 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:

IllegalArgumentException - if a container with the same name exists already

addContainer

@Nonnull
public Container addContainer(@Nonnull
 String name,
 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:

IllegalArgumentException - if a container with the same name exists already

addContainer

@Nonnull
public Container addContainer(@Nonnull
 String name,
 String description,
 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:

IllegalArgumentException - if a container with the same name exists already

getContainerWithName

@Nullable
public Container getContainerWithName(@Nonnull
 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:

IllegalArgumentException - if the name is null or empty

getContainerWithId

@Nullable
public Container getContainerWithId(@Nonnull
 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:

IllegalArgumentException - if the ID is null or empty

getCanonicalName

public 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

getDefaultTags

public Set<String> getDefaultTags()

Specified by:

getDefaultTags in class ModelItem

getDocumentation

public Documentation getDocumentation()

Gets the documentation associated with this software system.

Specified by:

getDocumentation in interface Documentable

Returns:

a Documentation object