Package com.structurizr.model

Class SoftwareSystemInstance

java.lang.Object

com.structurizr.model.ModelItem

com.structurizr.model.Element

com.structurizr.model.GroupableElement

com.structurizr.model.DeploymentElement

com.structurizr.model.StaticStructureElementInstance

com.structurizr.model.SoftwareSystemInstance

All Implemented Interfaces:

PropertyHolder

public final class SoftwareSystemInstance
extends StaticStructureElementInstance

Represents a deployment instance of a SoftwareSystem, which can be added to a DeploymentNode.

Field Summary

Fields inherited from class com.structurizr.model.DeploymentElement

DEFAULT_DEPLOYMENT_ENVIRONMENT, DEFAULT_DEPLOYMENT_GROUP

Method Summary

Modifier and Type	Method	Description
String	getCanonicalName()
StaticStructureElement	getElement()
SoftwareSystem	getSoftwareSystem()
String	getSoftwareSystemId()	Gets the ID of the software system that this object represents a deployment instance of.

Methods inherited from class com.structurizr.model.StaticStructureElementInstance

addHealthCheck, addHealthCheck, getDefaultTags, getDeploymentGroups, getHealthChecks, getInstanceId, getName, removeTag, setName, uses, uses, uses

Methods inherited from class com.structurizr.model.DeploymentElement

getEnvironment, getParent

Methods inherited from class com.structurizr.model.GroupableElement

getGroup, setGroup

Methods inherited from class com.structurizr.model.Element

getDescription, getEfferentRelationshipsWith, getEfferentRelationshipWith, getEfferentRelationshipWith, getModel, 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, setUrl

Methods inherited from class java.lang.Object

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

Method Details

getSoftwareSystem

public SoftwareSystem getSoftwareSystem()

getElement

public StaticStructureElement getElement()

Specified by:

getElement in class StaticStructureElementInstance

getSoftwareSystemId

public String getSoftwareSystemId()

Gets the ID of the software system that this object represents a deployment instance of.

Returns:

the software system ID, as a String

getCanonicalName

public String getCanonicalName()

Specified by:

getCanonicalName in class ModelItem