Package com.structurizr.model

Class Container

java.lang.Object

com.structurizr.model.ModelItem

com.structurizr.model.Element

com.structurizr.model.GroupableElement

com.structurizr.model.StaticStructureElement

com.structurizr.model.Container

All Implemented Interfaces:

Documentable, PropertyHolder, Comparable<ModelItem>

public final class Container
extends StaticStructureElement
implements Documentable

Represents a "container" in the C4 model.

Method Summary

Modifier and Type	Method	Description
Component	addComponent(String name)	Adds a component to this container.
Component	addComponent(String name, String description)	Adds a component to this container.
Component	addComponent(String name, String description, String technology)	Adds a component to this container.
String	getCanonicalName()	Gets the canonical name of this container, in the form "/Software System/Container".
Set<Component>	getComponents()	Gets the set of components within this software system.
Component	getComponentWithName(String name)	Gets the component with the specified name.
Set<String>	getDefaultTags()
Documentation	getDocumentation()	Gets the documentation associated with this container.
Element	getParent()	Gets the parent software system.
SoftwareSystem	getSoftwareSystem()	Gets the parent software system.
String	getTechnology()	Gets the technology associated with this container (e.g.
boolean	hasComponents()	Determines whether this container has any components.
void	setTechnology(String technology)	Sets the technology associated with this container.

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 software system.

Specified by:

getParent in class Element

Returns:

the parent SoftwareSystem instance

getSoftwareSystem

public SoftwareSystem getSoftwareSystem()

Gets the parent software system.

Returns:

the parent SoftwareSystem instance

getTechnology

public String getTechnology()

Gets the technology associated with this container (e.g. "Spring MVC application").

Returns:

the technology, as a String, or null if no technology has been specified

setTechnology

public void setTechnology(String technology)

Sets the technology associated with this container.

Parameters:

technology - the technology, as a String

addComponent

public Component addComponent(String name)

Adds a component to this container.

Parameters:

name - the name of the component

Returns:

the resulting Component instance

Throws:

IllegalArgumentException - if the component name is null or empty, or a component with the same name already exists

addComponent

public Component addComponent(String name,
 String description)

Adds a component to this container.

Parameters:

name - the name of the component

description - a description of the component

Returns:

the resulting Component instance

Throws:

IllegalArgumentException - if the component name is null or empty, or a component with the same name already exists

addComponent

public Component addComponent(String name,
 String description,
 String technology)

Adds a component to this container.

Parameters:

name - the name of the component

description - a description of the component

technology - the technology of the component

Returns:

the resulting Component instance

Throws:

IllegalArgumentException - if the component name is null or empty, or a component with the same name already exists

getComponents

public Set<Component> getComponents()

Gets the set of components within this software system.

Returns:

a Set of Component objects

hasComponents

public boolean hasComponents()

Determines whether this container has any components.

Returns:

true if it has components, false otherwise

getComponentWithName

public Component getComponentWithName(String name)

Gets the component with the specified name.

Parameters:

name - the name of the component

Returns:

the Component instance, or null if a component with the specified name does not exist

Throws:

IllegalArgumentException - if the name is null or empty

getCanonicalName

public String getCanonicalName()

Gets the canonical name of this container, in the form "/Software System/Container".

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 container.

Specified by:

getDocumentation in interface Documentable

Returns:

a Documentation object