Uses of Class
org.springframework.modulith.docs.Documenter.DiagramOptions

Packages that use Documenter.DiagramOptions

Package	Description
org.springframework.modulith.docs	Documentation support for Spring Modulith.

Uses of Documenter.DiagramOptions in org.springframework.modulith.docs

Methods in org.springframework.modulith.docs that return Documenter.DiagramOptions

Modifier and Type	Method	Description
static Documenter.DiagramOptions	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	Documenter.DiagramOptions.withColorSelector(Function<org.springframework.modulith.core.ApplicationModule,Optional<String>> colorSelector)	A callback to return a hex-encoded color per ApplicationModule.
Documenter.DiagramOptions	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	Documenter.DiagramOptions.withDefaultDisplayName(Function<org.springframework.modulith.core.ApplicationModule,String> defaultDisplayName)	A callback to return a default display names for a given ApplicationModule.
Documenter.DiagramOptions	Documenter.DiagramOptions.withDependencyDepth(org.springframework.modulith.core.DependencyDepth dependencyDepth)	The DependencyDepth to define which other modules to be included in the diagram to be created.
Documenter.DiagramOptions	Documenter.DiagramOptions.withDependencyTypes(org.springframework.modulith.core.DependencyType... types)	Select the dependency types that are supposed to be included in the diagram to be created.
Documenter.DiagramOptions	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	Documenter.DiagramOptions.withExclusions(Predicate<org.springframework.modulith.core.ApplicationModule> exclusions)	A Predicate to define the which modules to exclude from the diagram to be created.
Documenter.DiagramOptions	Documenter.DiagramOptions.withStyle(Documenter.DiagramOptions.DiagramStyle style)	Which style to render the diagram in.
Documenter.DiagramOptions	Documenter.DiagramOptions.withTargetFileName(String targetFileName)	The target file name to be used for the diagram to be created.
Documenter.DiagramOptions	Documenter.DiagramOptions.withTargetOnly(Predicate<org.springframework.modulith.core.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.

Methods in org.springframework.modulith.docs with parameters of type Documenter.DiagramOptions

Modifier and Type	Method	Description
Documenter	Documenter.writeAggregatingDocument(Documenter.DiagramOptions diagramOptions, Documenter.CanvasOptions canvasOptions)	Writes aggregating document called all-docs.adoc that includes any existing component diagrams and canvases.
Documenter	Documenter.writeDocumentation(Documenter.DiagramOptions diagramOptions, Documenter.CanvasOptions canvasOptions)	Writes all available documentation: The entire set of modules as overview component diagram. Individual component diagrams per module to include all upstream modules. The Module Canvas for each module.
Documenter	Documenter.writeIndividualModulesAsPlantUml(Documenter.DiagramOptions options)	Writes the component diagrams for all individual modules.
Documenter	Documenter.writeModuleAsPlantUml(org.springframework.modulith.core.ApplicationModule module, Documenter.DiagramOptions options)	Writes the PlantUML component diagram for the given ApplicationModule with the given rendering Documenter.DiagramOptions.
Documenter	Documenter.writeModulesAsPlantUml(Documenter.DiagramOptions diagramOptions)	Writes the PlantUML component diagram for all ApplicationModules with the given Documenter.DiagramOptions.