Package com.structurizr.model

Enum Class InteractionStyle

java.lang.Object

java.lang.Enum<InteractionStyle>

com.structurizr.model.InteractionStyle

All Implemented Interfaces:

Serializable, Comparable<InteractionStyle>, Constable

public enum InteractionStyle
extends Enum<InteractionStyle>

Use InteractionStyles on Relationships 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.

See Also:

• Styles.addRelationshipStyle(String)
• Tags.SYNCHRONOUS
• Tags.ASYNCHRONOUS

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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(String name)	Returns the enum constant of this class with the specified name.
static InteractionStyle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Synchronous

public static final InteractionStyle Synchronous

Denotes synchronous communication. The tag Tags.SYNCHRONOUS is automatically added to such Relationships, so you might use that tag to adapt the relationship style in the diagram

See Also:

• Tags.SYNCHRONOUS

Asynchronous

public static final InteractionStyle Asynchronous

Denotes asynchronous communication. The tag Tags.ASYNCHRONOUS is automatically added to such Relationships, so you might use that tag to adapt the relationship style in the diagram

See Also:

• Tags.ASYNCHRONOUS

Method Details

values

public static InteractionStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static InteractionStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null