Package com.structurizr.model
Class CustomElement
java.lang.Object
com.structurizr.model.ModelItem
com.structurizr.model.Element
com.structurizr.model.GroupableElement
com.structurizr.model.CustomElement
public final class CustomElement extends GroupableElement
Represents a custom element.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CustomElement()
-
Method Summary
Modifier and Type Method Description java.lang.String
getCanonicalName()
java.lang.String
getMetadata()
Element
getParent()
Gets the parent of this element.protected java.util.Set<java.lang.String>
getRequiredTags()
void
setMetadata(java.lang.String metadata)
Relationship
uses(Element destination, java.lang.String description)
Adds a unidirectional "uses" style relationship between this custom element and the specified element.Relationship
uses(Element destination, java.lang.String description, java.lang.String technology)
Adds a unidirectional "uses" style relationship between this custom element and the specified element.Relationship
uses(Element destination, java.lang.String description, java.lang.String technology, InteractionStyle interactionStyle)
Adds a unidirectional "uses" style relationship between this custom element and the specified element.Relationship
uses(Element destination, java.lang.String description, java.lang.String technology, InteractionStyle interactionStyle, java.lang.String[] tags)
Adds a unidirectional "uses" style relationship between this custom element and the specified element.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, getOriginId, getPerspectives, getProperties, getTags, getTagsAsSet, getUrl, hasTag, removeTag, setUrl
-
Constructor Details
-
CustomElement
protected CustomElement()
-
-
Method Details
-
getParent
Description copied from class:Element
Gets the parent of this element. -
getRequiredTags
protected java.util.Set<java.lang.String> getRequiredTags()- Specified by:
getRequiredTags
in classModelItem
-
getCanonicalName
public java.lang.String getCanonicalName()- Specified by:
getCanonicalName
in classModelItem
-
getMetadata
public java.lang.String getMetadata() -
setMetadata
public void setMetadata(java.lang.String metadata) -
uses
Adds a unidirectional "uses" style relationship between this custom element and the specified element.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Element destination, java.lang.String description, java.lang.String technology)Adds a unidirectional "uses" style relationship between this custom element and the specified element.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)- Returns:
- the relationship that has just been created and added to the model
-
uses
@Nullable public Relationship uses(@Nonnull Element destination, java.lang.String description, java.lang.String technology, InteractionStyle interactionStyle)Adds a unidirectional "uses" style relationship between this custom element and the specified element.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data 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
-
uses
@Nullable public Relationship uses(@Nonnull Element destination, java.lang.String description, java.lang.String technology, InteractionStyle interactionStyle, java.lang.String[] tags)Adds a unidirectional "uses" style relationship between this custom element and the specified element.- Parameters:
destination
- the target of the relationshipdescription
- a description of the relationship (e.g. "uses", "gets data from", "sends data to")technology
- the technology details (e.g. JSON/HTTPS)interactionStyle
- the interaction style (sync vs async)tags
- an array of tags- Returns:
- the relationship that has just been created and added to the model
-