Package org.springframework.modulith.docs

Enum Class Documenter.DiagramOptions.ElementsWithoutRelationships

java.lang.Object

java.lang.Enum<Documenter.DiagramOptions.ElementsWithoutRelationships>

org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships

All Implemented Interfaces:

Serializable, Comparable<Documenter.DiagramOptions.ElementsWithoutRelationships>, Constable

Enclosing class:

Documenter.DiagramOptions

public static enum Documenter.DiagramOptions.ElementsWithoutRelationships
extends Enum<Documenter.DiagramOptions.ElementsWithoutRelationships>

Configuration setting to define whether modules that do not have a relationship to any other module shall be retained in the diagrams created. The default is HIDDEN. See Documenter.DiagramOptions.withExclusions(Predicate) for a more fine-grained way of defining which modules to exclude in case you flip this to VISIBLE.

Author:

Oliver Drotbohm

See Also:

• Documenter.DiagramOptions.withExclusions(Predicate)

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
HIDDEN
VISIBLE

Method Summary

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

HIDDEN

public static final Documenter.DiagramOptions.ElementsWithoutRelationships HIDDEN

VISIBLE

public static final Documenter.DiagramOptions.ElementsWithoutRelationships VISIBLE

Method Details

values

public static Documenter.DiagramOptions.ElementsWithoutRelationships[] 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 Documenter.DiagramOptions.ElementsWithoutRelationships 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