Package com.structurizr.model
Class Component
- All Implemented Interfaces:
Documentable
,PropertyHolder
Represents a "component" in the C4 model.
-
Method Summary
Modifier and TypeMethodDescriptionGets the canonical name of this component, in the form "/Software System/Container/Component".Gets the documentation associated with this component.Gets the parent of this element.Gets the technology associated with this component (e.g.void
setTechnology
(String technology) Sets the technology associated with this component (e.g.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, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setUrl
-
Method Details
-
getParent
Description copied from class:Element
Gets the parent of this element. -
getContainer
-
getTechnology
Gets the technology associated with this component (e.g. "Spring Bean").- Returns:
- the technology, as a String, or null if no technology has been specified
-
setTechnology
Sets the technology associated with this component (e.g. "Spring Bean").- Parameters:
technology
- the technology, as a String
-
getCanonicalName
Gets the canonical name of this component, in the form "/Software System/Container/Component".- Specified by:
getCanonicalName
in classModelItem
- Returns:
- the canonical name, as a String
-
getDefaultTags
- Specified by:
getDefaultTags
in classModelItem
-
getDocumentation
Gets the documentation associated with this component.- Specified by:
getDocumentation
in interfaceDocumentable
- Returns:
- a Documentation object
-