Package com.structurizr.view
Class ContainerView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.StaticView
com.structurizr.view.ContainerView
- All Implemented Interfaces:
PropertyHolder
Represents a Container view from the C4 model, showing the containers within a given software system.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an individual container (belonging to any software system) to this view, including relationships to/from that container.void
Adds an individual container (belonging to any software system) to this view.void
add
(SoftwareSystem softwareSystem) Adds a software system to this view, including relationships to/from that software system.void
Adds all containers within the software system in scope to this view.final void
Adds allContainer
s of the givenContainerView
as well as all external influencers, that is all persons and all other software systems with incoming or outgoing dependencies.void
Adds all people, software systems and containers that belong to the software system in scope.final void
Adds allContainer
s of the givenContainerView
as well as all external influencers, that is all persons and all other software systems with incoming or outgoing dependencies.void
Adds the default set of elements to this view.final void
void
addNearestNeighbours
(Element element) Adds all people, software systems and containers that are directly connected to the specified element.protected boolean
canBeRemoved
(Element element) protected void
checkElementCanBeAdded
(Element element) boolean
Determines whether software system boundaries should be visible for "external" containers (those outside the software system in scope).getName()
Gets the (computed) name of this view.void
Removes an individual container from this view.void
setExternalSoftwareSystemBoundariesVisible
(boolean externalSoftwareSystemBoundariesVisible) Sets whether software system boundaries should be visible for "external" containers (those outside the software system in scope).Methods inherited from class com.structurizr.view.StaticView
add, add, add, add, add, add, addAllPeople, addAllSoftwareSystems, addAnimation, getAnimations, remove, remove, remove, removeElementsThatAreUnreachableFrom, removeElementsWithTag, removeRelationshipsWithTag
Methods inherited from class com.structurizr.view.View
addElement, addNearestNeighbours, addProperty, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDescription, getDimensions, getElements, getElementView, getKey, getMergeFromRemote, getModel, getOrder, getPaperSize, getProperties, getRelationships, getRelationshipView, getSoftwareSystem, getSoftwareSystemId, getTitle, getViewSet, isElementInView, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDescription, setDimensions, setLayoutMergeStrategy, setMergeFromRemote, setPaperSize, setTitle
-
Method Details
-
add
Adds a software system to this view, including relationships to/from that software system. Please note that you cannot add the software system that is the scope of this view.- Overrides:
add
in classStaticView
- Parameters:
softwareSystem
- the SoftwareSystem to add
-
addAllContainers
public void addAllContainers()Adds all containers within the software system in scope to this view. -
add
Adds an individual container (belonging to any software system) to this view, including relationships to/from that container.- Parameters:
container
- the Container to add
-
add
Adds an individual container (belonging to any software system) to this view.- Parameters:
container
- the Container to addaddRelationships
- whether to add relationships to/from the container
-
remove
Removes an individual container from this view.- Parameters:
container
- the Container to remove
-
getName
Gets the (computed) name of this view. -
addDefaultElements
public void addDefaultElements()Adds the default set of elements to this view.- Specified by:
addDefaultElements
in classStaticView
-
addAllElements
public void addAllElements()Adds all people, software systems and containers that belong to the software system in scope.- Specified by:
addAllElements
in classStaticView
-
addNearestNeighbours
Adds all people, software systems and containers that are directly connected to the specified element.- Specified by:
addNearestNeighbours
in classStaticView
- Parameters:
element
- an Element
-
addAllInfluencers
public final void addAllInfluencers()Adds all
Container
s of the givenContainerView
as well as all external influencers, that is all persons and all other software systems with incoming or outgoing dependencies.Additionally, all relationships of external dependencies are omitted to keep the diagram clean
-
addAllContainersAndInfluencers
public final void addAllContainersAndInfluencers()Adds all
Container
s of the givenContainerView
as well as all external influencers, that is all persons and all other software systems with incoming or outgoing dependencies.Additionally, all relationships of external dependencies are omitted to keep the diagram clean
-
addDependentSoftwareSystems
public final void addDependentSoftwareSystems() -
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classView
-
canBeRemoved
- Specified by:
canBeRemoved
in classView
-
getExternalSoftwareSystemBoundariesVisible
public boolean getExternalSoftwareSystemBoundariesVisible()Determines whether software system boundaries should be visible for "external" containers (those outside the software system in scope).- Returns:
- true if external software system boundaries are visible, false otherwise
-
setExternalSoftwareSystemBoundariesVisible
public void setExternalSoftwareSystemBoundariesVisible(boolean externalSoftwareSystemBoundariesVisible) Sets whether software system boundaries should be visible for "external" containers (those outside the software system in scope).- Parameters:
externalSoftwareSystemBoundariesVisible
- true if external software system boundaries should be visible, false otherwise
-