Package com.structurizr.view

Enum Class ViewSortOrder

java.lang.Object

java.lang.Enum<ViewSortOrder>

com.structurizr.view.ViewSortOrder

All Implemented Interfaces:

Serializable, Comparable<ViewSortOrder>, Constable

public enum ViewSortOrder
extends Enum<ViewSortOrder>

Allows the sort order of views to be customized as follows:

• Default: Views are grouped by the software system they are associated with, and then sorted by type (System Landscape, System Context, Container, Component, Dynamic and Deployment) within these groups.
• Type: Views are sorted by type (System Landscape, System Context, Container, Component, Dynamic and Deployment).
• Key: Views are sorted by the view key (alphabetical, ascending).

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
Default
Key
Type

Method Summary

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

Default

public static final ViewSortOrder Default

Type

public static final ViewSortOrder Type

Key

public static final ViewSortOrder Key

Method Details

values

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