Package com.structurizr.model
Class Relationship
java.lang.Object
com.structurizr.model.ModelItem
com.structurizr.model.Relationship
public final class Relationship extends ModelItem
A relationship between two elements.
-
Method Summary
Modifier and Type Method Description java.lang.String
getCanonicalName()
java.lang.String
getDescription()
Element
getDestination()
java.lang.String
getDestinationId()
Gets the ID of the destination element.InteractionStyle
getInteractionStyle()
Gets the interaction style (synchronous or asynchronous).java.lang.String
getLinkedRelationshipId()
Model
getModel()
protected java.util.Set<java.lang.String>
getRequiredTags()
Element
getSource()
java.lang.String
getSourceId()
Gets the ID of the source element.java.lang.String
getTechnology()
Gets the technology associated with this relationship (e.g.protected void
setModel(Model model)
java.lang.String
toString()
Methods inherited from class com.structurizr.model.ModelItem
addPerspective, addProperty, addTags, getId, getOriginId, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setUrl
-
Method Details
-
getModel
-
setModel
-
getCanonicalName
public java.lang.String getCanonicalName()- Specified by:
getCanonicalName
in classModelItem
-
getSource
-
getSourceId
public java.lang.String getSourceId()Gets the ID of the source element.- Returns:
- the ID of the source element, as a String
-
getDestination
-
getDestinationId
public java.lang.String getDestinationId()Gets the ID of the destination element.- Returns:
- the ID of the destination element, as a String
-
getDescription
public java.lang.String getDescription() -
getTechnology
public java.lang.String getTechnology()Gets the technology associated with this relationship (e.g. HTTPS, JDBC, etc).- Returns:
- the technology as a String, or null if a technology is not specified
-
getInteractionStyle
Gets the interaction style (synchronous or asynchronous).- Returns:
- an InteractionStyle, or null if an interaction style has not been specified
-
getLinkedRelationshipId
public java.lang.String getLinkedRelationshipId() -
getRequiredTags
protected java.util.Set<java.lang.String> getRequiredTags()- Specified by:
getRequiredTags
in classModelItem
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-