Package org.springframework.modulith.docs

Class Documenter.DiagramOptions

java.lang.Object

org.springframework.modulith.docs.Documenter.DiagramOptions

Enclosing class:

Documenter

public static class Documenter.DiagramOptions
extends Object

Options to tweak the rendering of diagrams.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Documenter.DiagramOptions.DiagramStyle	Different diagram styles.
static 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.

Constructor Summary

Constructors

Constructor

Description

DiagramOptions(Set<DependencyType> dependencyTypes, DependencyDepth dependencyDepth, Predicate<ApplicationModule> exclusions, Predicate<com.structurizr.model.Component> componentFilter, Predicate<ApplicationModule> targetOnly, String targetFileName, Function<ApplicationModule,Optional<String>> colorSelector, Function<ApplicationModule,String> defaultDisplayName, Documenter.DiagramOptions.DiagramStyle style, Documenter.DiagramOptions.ElementsWithoutRelationships elementsWithoutRelationships)

Method Summary

Modifier and Type	Method	Description
static Documenter.DiagramOptions	defaults()	Creates a new default Documenter.DiagramOptions instance configured to use all dependency types, list immediate dependencies for individual module instances, not applying any kind of ApplicationModule or Component filters and default file names.
Documenter.DiagramOptions	withColorSelector(Function<ApplicationModule,Optional<String>> colorSelector)	A callback to return a hex-encoded color per ApplicationModule.
Documenter.DiagramOptions	withComponentFilter(Predicate<com.structurizr.model.Component> componentFilter)	A Predicate to define which Structurizr Components to be included in the diagram to be created.
Documenter.DiagramOptions	withDefaultDisplayName(Function<ApplicationModule,String> defaultDisplayName)	A callback to return a default display names for a given ApplicationModule.
Documenter.DiagramOptions	withDependencyDepth(DependencyDepth dependencyDepth)	The DependencyDepth to define which other modules to be included in the diagram to be created.
Documenter.DiagramOptions	withDependencyTypes(DependencyType... types)	Select the dependency types that are supposed to be included in the diagram to be created.
Documenter.DiagramOptions	withElementsWithoutRelationships(Documenter.DiagramOptions.ElementsWithoutRelationships elementsWithoutRelationships)	Configuration setting to define whether modules that do not have a relationship to any other module shall be retained in the diagrams created.
Documenter.DiagramOptions	withExclusions(Predicate<ApplicationModule> exclusions)	A Predicate to define the which modules to exclude from the diagram to be created.
Documenter.DiagramOptions	withStyle(Documenter.DiagramOptions.DiagramStyle style)	Which style to render the diagram in.
Documenter.DiagramOptions	withTargetFileName(String targetFileName)	The target file name to be used for the diagram to be created.
Documenter.DiagramOptions	withTargetOnly(Predicate<ApplicationModule> targetOnly)	A Predicate to define which of the modules shall only be considered targets, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DiagramOptions

DiagramOptions(Set<DependencyType> dependencyTypes,
 DependencyDepth dependencyDepth,
 Predicate<ApplicationModule> exclusions,
 Predicate<com.structurizr.model.Component> componentFilter,
 Predicate<ApplicationModule> targetOnly,
 @Nullable
 String targetFileName,
 Function<ApplicationModule,Optional<String>> colorSelector,
 Function<ApplicationModule,String> defaultDisplayName,
 Documenter.DiagramOptions.DiagramStyle style,
 Documenter.DiagramOptions.ElementsWithoutRelationships elementsWithoutRelationships)

Parameters:

dependencyTypes - must not be null.

dependencyDepth - must not be null.

exclusions - must not be null.

componentFilter - must not be null.

targetOnly - must not be null.

targetFileName - can be null.

colorSelector - must not be null.

defaultDisplayName - must not be null.

style - must not be null.

elementsWithoutRelationships - must not be null.

Method Details

withDependencyDepth

public Documenter.DiagramOptions withDependencyDepth(DependencyDepth dependencyDepth)

The DependencyDepth to define which other modules to be included in the diagram to be created.

withExclusions

public Documenter.DiagramOptions withExclusions(Predicate<ApplicationModule> exclusions)

A Predicate to define the which modules to exclude from the diagram to be created.

withComponentFilter

public Documenter.DiagramOptions withComponentFilter(Predicate<com.structurizr.model.Component> componentFilter)

A Predicate to define which Structurizr Components to be included in the diagram to be created.

withTargetOnly

public Documenter.DiagramOptions withTargetOnly(Predicate<ApplicationModule> targetOnly)

A Predicate to define which of the modules shall only be considered targets, i.e. all efferent relationships are going to be hidden from the rendered view. Modules that have no incoming relationships will entirely be removed from the view.

withTargetFileName

public Documenter.DiagramOptions withTargetFileName(String targetFileName)

The target file name to be used for the diagram to be created. For individual module diagrams this needs to include a %s placeholder for the module names.

withColorSelector

public Documenter.DiagramOptions withColorSelector(Function<ApplicationModule,Optional<String>> colorSelector)

A callback to return a hex-encoded color per ApplicationModule.

withDefaultDisplayName

public Documenter.DiagramOptions withDefaultDisplayName(Function<ApplicationModule,String> defaultDisplayName)

A callback to return a default display names for a given ApplicationModule. Default implementation just forwards to ApplicationModule.getDisplayName().

withStyle

public Documenter.DiagramOptions withStyle(Documenter.DiagramOptions.DiagramStyle style)

Which style to render the diagram in. Defaults to Documenter.DiagramOptions.DiagramStyle.UML.

withElementsWithoutRelationships

public Documenter.DiagramOptions withElementsWithoutRelationships(Documenter.DiagramOptions.ElementsWithoutRelationships 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 Documenter.DiagramOptions.ElementsWithoutRelationships.HIDDEN. See withExclusions(Predicate) for a more fine-grained way of defining which modules to exclude in case you flip this to Documenter.DiagramOptions.ElementsWithoutRelationships.VISIBLE.

See Also:

• withExclusions(Predicate)

defaults

public static Documenter.DiagramOptions defaults()

Creates a new default Documenter.DiagramOptions instance configured to use all dependency types, list immediate dependencies for individual module instances, not applying any kind of ApplicationModule or Component filters and default file names.

Returns:

will never be null.

withDependencyTypes

public Documenter.DiagramOptions withDependencyTypes(DependencyType... types)

Select the dependency types that are supposed to be included in the diagram to be created.

Parameters:

types - must not be null.

Returns: