Package com.structurizr.model

Class Component

java.lang.Object

com.structurizr.model.ModelItem

com.structurizr.model.Element

com.structurizr.model.GroupableElement

com.structurizr.model.StaticStructureElement

com.structurizr.model.Component

All Implemented Interfaces:

Documentable, PropertyHolder, Comparable<ModelItem>

public final class Component
extends StaticStructureElement
implements Documentable

Represents a "component" in the C4 model.

Method Summary

Modifier and Type	Method	Description
String	getCanonicalName()	Gets the canonical name of this component, in the form "/Software System/Container/Component".
Container	getContainer()
Set<String>	getDefaultTags()
Documentation	getDocumentation()	Gets the documentation associated with this component.
Element	getParent()	Gets the parent of this element.
String	getTechnology()	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, 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()

Description copied from class: Element

Gets the parent of this element.

Specified by:

getParent in class Element

Returns:

the parent Element, or null if this element doesn't have a parent (i.e. a Person or SoftwareSystem)

getContainer

public Container getContainer()

getTechnology

public String 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

public void setTechnology(String technology)

Sets the technology associated with this component (e.g. "Spring Bean").

Parameters:

technology - the technology, as a String

getCanonicalName

public String getCanonicalName()

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

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

Specified by:

getDocumentation in interface Documentable

Returns:

a Documentation object