Package com.structurizr.model
Enum InteractionStyle
java.lang.Object
java.lang.Enum<InteractionStyle>
com.structurizr.model.InteractionStyle
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<InteractionStyle>
,java.lang.constant.Constable
public enum InteractionStyle extends java.lang.Enum<InteractionStyle>
Use
InteractionStyle
s on Relationship
s to make the difference between synchronous and asynchronous communication
visible. Use Styles.add(RelationshipStyle)
and pass either Tags.SYNCHRONOUS
or Tags.ASYNCHRONOUS
to define different styles for synchronous and asynchronous communication.-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description Asynchronous
Denotes asynchronous communication.Synchronous
Denotes synchronous communication. -
Method Summary
Modifier and Type Method Description static InteractionStyle
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static InteractionStyle[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
Synchronous
Denotes synchronous communication. The tagTags.SYNCHRONOUS
is automatically added to suchRelationship
s, so you might use that tag to adapt the relationship style in the diagram- See Also:
Tags.SYNCHRONOUS
-
Asynchronous
Denotes asynchronous communication. The tagTags.ASYNCHRONOUS
is automatically added to suchRelationship
s, so you might use that tag to adapt the relationship style in the diagram- See Also:
Tags.ASYNCHRONOUS
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-