Package com.structurizr.model

Enum Class CodeElementRole

java.lang.Object

java.lang.Enum<CodeElementRole>

com.structurizr.model.CodeElementRole

All Implemented Interfaces:

Serializable, Comparable<CodeElementRole>, Constable

public enum CodeElementRole
extends Enum<CodeElementRole>

Used to represent the role of a code element. A component can have one primary code element, and zero or more supporting code elements associated with it.

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
Primary
Supporting

Method Summary

Modifier and Type	Method	Description
static CodeElementRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CodeElementRole[]	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

Primary

public static final CodeElementRole Primary

Supporting

public static final CodeElementRole Supporting

Method Details

values

public static CodeElementRole[] 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 CodeElementRole 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