Package com.structurizr.model

Enum CodeElementRole

java.lang.Object
java.lang.Enum<CodeElementRole>
com.structurizr.model.CodeElementRole
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CodeElementRole>, java.lang.constant.Constable
public enum CodeElementRole
extends java.lang.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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    Primary  
    Supporting  

  • Method Summary

    Modifier and Type Method Description
    static CodeElementRole valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static CodeElementRole[] values()
    Returns an array containing the constants of this enum type, 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

  • Method Details

    • values

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

      public static CodeElementRole valueOf​(java.lang.String name)
      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 name
      java.lang.NullPointerException - if the argument is null