Package com.structurizr.model

Class Component

java.lang.Object
com.structurizr.model.Element
com.structurizr.model.StaticStructureElement
com.structurizr.model.Component
public final class Component
extends StaticStructureElement
Represents a "component" in the C4 model.

  • 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 java.lang.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​(java.lang.String technology)
      Sets the technology associated with this component (e.g. "Spring Bean").
      Parameters:
      technology - the technology, as a String

    • getType

      public CodeElement getType()
      Gets the type of this component (e.g. a fully qualified Java interface/class name).
      Returns:
      the type, as a String

    • setType

      public CodeElement setType​(java.lang.String type)
      Sets the type of this component (e.g. a fully qualified Java interface/class name).
      Parameters:
      type - the fully qualified type name
      Returns:
      the CodeElement that was created
      Throws:
      java.lang.IllegalArgumentException - if the specified type is null

    • getCode

      public java.util.Set<CodeElement> getCode()
      Gets the set of CodeElement objects.
      Returns:
      a Set, which could be empty

    • addSupportingType

      public CodeElement addSupportingType​(java.lang.String type)
      Adds a supporting type to this Component.
      Parameters:
      type - the fully qualified type name
      Returns:
      a CodeElement representing the supporting type
      Throws:
      java.lang.IllegalArgumentException - if the specified type is null

    • getSize

      public long getSize()
      Gets the size of this Component (e.g. number of lines).
      Returns:
      the size of this component, as a long

    • setSize

      public void setSize​(long size)
      Sets the size of this component (e.g. number of lines).
      Parameters:
      size - the size

    • getCanonicalName

      public java.lang.String getCanonicalName()
      Gets the canonical name of this component, in the form "/Software System/Container/Component".
      Specified by:
      getCanonicalName in class Element
      Returns:
      the canonical name, as a String

    • getRequiredTags

      protected java.util.Set<java.lang.String> getRequiredTags()

    • getId

      public java.lang.String getId()
      Gets the ID of this item in the model.
      Returns:
      the ID, as a String

    • getTags

      public java.lang.String getTags()
      Gets the comma separated list of tags.
      Returns:
      a comma separated list of tags, or an empty string if there are no tags

    • getTagsAsSet

      public java.util.Set<java.lang.String> getTagsAsSet()

    • addTags

      public void addTags​(java.lang.String... tags)

    • removeTag

      public boolean removeTag​(java.lang.String tag)
      Removes the given tag.
      Parameters:
      tag - the tag to remove
      Returns:
      true if the tag was removed; will return false if a non-existent tag is passed, or if an attempt is made to remove required tags, which cannot be removed.

    • hasTag

      public boolean hasTag​(java.lang.String tag)
      Determines whether this model item has the given tag.
      Parameters:
      tag - the tag to check for
      Returns:
      true if tag is present as a tag on this item, or if it is one of the required tags defined by the model in getRequiredTags(), false otherwise

    • getProperties

      public java.util.Map<java.lang.String,​java.lang.String> getProperties()
      Gets the collection of name-value property pairs associated with this element, as a Map.
      Returns:
      a Map (String, String) (empty if there are no properties)

    • addProperty

      public void addProperty​(java.lang.String name, java.lang.String value)
      Adds a name-value pair property to this element.
      Parameters:
      name - the name of the property
      value - the value of the property

    • getPerspectives

      public java.util.Set<Perspective> getPerspectives()
      Gets the set of perspectives associated with this model item.
      Returns:
      a Set of Perspective objects (empty if there are none)

    • addPerspective

      public Perspective addPerspective​(java.lang.String name, java.lang.String description)
      Adds a perspective to this model item.
      Parameters:
      name - the name of the perspective (e.g. "Security", must be unique)
      description - a description of the perspective
      Returns:
      a Perspective object
      Throws:
      java.lang.IllegalArgumentException - if perspective details are not specified, or the named perspective exists already