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
- All Implemented Interfaces:
PropertyHolder
Represents a custom element.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the parent of this element.void
setMetadata
(String metadata) Adds a unidirectional "uses" style relationship between this custom element and the specified element.Adds a unidirectional "uses" style relationship between this custom element and the specified element.uses
(Element destination, String description, String technology, InteractionStyle interactionStyle) Adds a unidirectional "uses" style relationship between this custom element and the specified element.uses
(Element destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) Adds a unidirectional "uses" style relationship between this custom element and the specified element.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, addProperty, addTags, getId, 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. -
getDefaultTags
- Specified by:
getDefaultTags
in classModelItem
-
getCanonicalName
- Specified by:
getCanonicalName
in classModelItem
-
getMetadata
-
setMetadata
-
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, String description, 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, String description, 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, String description, String technology, InteractionStyle interactionStyle, 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
-