Package com.structurizr.model

Class Person

java.lang.Object
com.structurizr.model.Element
com.structurizr.model.StaticStructureElement
com.structurizr.model.Person
public final class Person
extends StaticStructureElement
Represents a "person" 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)

    • getLocation

      public Location getLocation()
      Gets the location of this person.
      Returns:
      a Location

    • setLocation

      public void setLocation​(Location location)

    • getCanonicalName

      public java.lang.String getCanonicalName()
      Specified by:
      getCanonicalName in class Element

    • getRequiredTags

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

    • delivers

      public Relationship delivers​(@Nonnull Person destination, java.lang.String description)
      Description copied from class: StaticStructureElement
      Adds a unidirectional relationship between this element and a person.
      Overrides:
      delivers in class StaticStructureElement
      Parameters:
      destination - the target of the relationship
      description - a description of the relationship (e.g. "sends e-mail to")
      Returns:
      the relationship that has just been created and added to the model

    • delivers

      public Relationship delivers​(Person destination, java.lang.String description, java.lang.String technology)
      Description copied from class: StaticStructureElement
      Adds a unidirectional relationship between this element and a person.
      Overrides:
      delivers in class StaticStructureElement
      Parameters:
      destination - the target of the relationship
      description - a description of the relationship (e.g. "sends e-mail to")
      technology - the technology details (e.g. JSON/HTTPS)
      Returns:
      the relationship that has just been created and added to the model

    • delivers

      public Relationship delivers​(Person destination, java.lang.String description, java.lang.String technology, InteractionStyle interactionStyle)
      Description copied from class: StaticStructureElement
      Adds a unidirectional relationship between this element and a person.
      Overrides:
      delivers in class StaticStructureElement
      Parameters:
      destination - the target of the relationship
      description - a description of the relationship (e.g. "sends e-mail to")
      technology - the technology details (e.g. JSON/HTTPS)
      interactionStyle - the interaction style (sync vs async)
      Returns:
      the relationship that has just been created and added to the model

    • interactsWith

      public Relationship interactsWith​(Person destination, java.lang.String description)
      Adds an interaction between this person and another.
      Parameters:
      destination - the Person being interacted with
      description - a description of the interaction
      Returns:
      the resulting Relatioship

    • interactsWith

      public Relationship interactsWith​(Person destination, java.lang.String description, java.lang.String technology)
      Adds an interaction between this person and another.
      Parameters:
      destination - the Person being interacted with
      description - a description of the interaction
      technology - the technology of the interaction (e.g. Telephone)
      Returns:
      the resulting Relatioship

    • interactsWith

      public Relationship interactsWith​(Person destination, java.lang.String description, java.lang.String technology, InteractionStyle interactionStyle)
      Adds an interaction between this person and another.
      Parameters:
      destination - the Person being interacted with
      description - a description of the interaction
      technology - the technology of the interaction (e.g. Telephone)
      interactionStyle - the interaction style (e.g. Synchronous or Asynchronous)
      Returns:
      the resulting Relatioship

    • 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