Index (Spring Modulith - Docs 0.5.1 API)

A B C D E F G H I K M N O R S T U V W
All Classes and Interfaces|All Packages

A

Asciidoctor - Class in org.springframework.modulith.docs

B

byGrouping(Documenter.CanvasOptions.Grouping) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Groupings
byGroupName(String) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Groupings

C

C4 - Enum constant in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.DiagramStyle: A C4 model component diagram.
CanvasOptions(List<Documenter.CanvasOptions.Grouping>, String, String, boolean, boolean) - Constructor for class org.springframework.modulith.docs.Documenter.CanvasOptions
CodeReplacingDocumentationSource - Class in org.springframework.modulith.docs: A DocumentationSource that replaces {@code …} or {@link …} blocks into inline code references
CodeReplacingDocumentationSource(DocumentationSource, Asciidoctor) - Constructor for class org.springframework.modulith.docs.CodeReplacingDocumentationSource: Creates a new CodeReplacingDocumentationSource for the given delegate DocumentationSource and Asciidoctor instance.
ConfigurationProperties - Class in org.springframework.modulith.docs: Represents all ConfigurationProperties.ConfigurationProperty instances found for the current project.
ConfigurationProperties() - Constructor for class org.springframework.modulith.docs.ConfigurationProperties: Creates a new ConfigurationProperties instance.
ConfigurationProperties.ConfigurationProperty - Record Class in org.springframework.modulith.docs
ConfigurationProperties.ModuleProperty - Record Class in org.springframework.modulith.docs
ConfigurationProperty(String, String, String, String, String) - Constructor for record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Creates an instance of a ConfigurationProperty record class.

D

defaults() - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions
defaults() - Static method in class org.springframework.modulith.docs.Documenter.DiagramOptions: 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.
defaultValue() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns the value of the defaultValue record component.
defaultValue() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns the value of the defaultValue record component.
description() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns the value of the description record component.
description() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns the value of the description record component.
DiagramOptions(Set<DependencyType>, DependencyDepth, Predicate<ApplicationModule>, Predicate<Component>, Predicate<ApplicationModule>, String, Function<ApplicationModule, Optional<String>>, Function<ApplicationModule, String>, Documenter.DiagramOptions.DiagramStyle, Documenter.DiagramOptions.ElementsWithoutRelationships) - Constructor for class org.springframework.modulith.docs.Documenter.DiagramOptions
DocumentationSource - Interface in org.springframework.modulith.docs: Interface to abstract different ways of looking up documentation for code abstractions.
Documenter - Class in org.springframework.modulith.docs: API to create documentation for ApplicationModules.
Documenter(Class<?>) - Constructor for class org.springframework.modulith.docs.Documenter: Creates a new Documenter for the ApplicationModules created for the given modulith type in the default output folder (spring-modulith-docs).
Documenter(ApplicationModules) - Constructor for class org.springframework.modulith.docs.Documenter: Creates a new Documenter for the given ApplicationModules instance in the default output folder (spring-modulith-docs).
Documenter(ApplicationModules, String) - Constructor for class org.springframework.modulith.docs.Documenter: Creates a new Documenter for the given ApplicationModules and output folder.
Documenter.CanvasOptions - Class in org.springframework.modulith.docs
Documenter.CanvasOptions.Grouping - Class in org.springframework.modulith.docs
Documenter.CanvasOptions.Groupings - Class in org.springframework.modulith.docs
Documenter.DiagramOptions - Class in org.springframework.modulith.docs: Options to tweak the rendering of diagrams.
Documenter.DiagramOptions.DiagramStyle - Enum Class in org.springframework.modulith.docs: Different diagram styles.
Documenter.DiagramOptions.ElementsWithoutRelationships - Enum Class in org.springframework.modulith.docs: Configuration setting to define whether modules that do not have a relationship to any other module shall be retained in the diagrams created.

E

equals(Object) - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Indicates whether some other object is "equal to" this one.

F

FALLBACK_GROUP - Static variable in class org.springframework.modulith.docs.Documenter.CanvasOptions
forEach(BiConsumer<Documenter.CanvasOptions.Grouping, List<SpringBean>>) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Groupings

G

getApiBase() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions
getDescription() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Returns the description of the Documenter.CanvasOptions.Grouping.
getDocumentation(JavaMethod) - Method in class org.springframework.modulith.docs.CodeReplacingDocumentationSource
getDocumentation(JavaMethod) - Method in interface org.springframework.modulith.docs.DocumentationSource: Returns the documentation to be used for the given JavaMethod.
getDocumentation(JavaMethod) - Method in class org.springframework.modulith.docs.SpringAutoRestDocsDocumentationSource
getModuleProperties(ApplicationModule) - Method in class org.springframework.modulith.docs.ConfigurationProperties: Returns all ConfigurationProperties.ModuleProperty instances for the given ApplicationModule.
getModules() - Method in class org.springframework.modulith.docs.Documenter
getName() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Returns the name of the Documenter.CanvasOptions.Grouping.
groupBeans(ApplicationModule) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions
groupingBy(String, Predicate<SpringBean>) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions: Registers a component grouping with the given name and selecting filter.
groupingBy(String, Predicate<SpringBean>, String) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions: Registers a component grouping with the given name, selecting filter and description.
groupingBy(Documenter.CanvasOptions.Grouping...) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions
Groupings(MultiValueMap<Documenter.CanvasOptions.Grouping, SpringBean>) - Constructor for class org.springframework.modulith.docs.Documenter.CanvasOptions.Groupings

H

hashCode() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns a hash code value for this object.
hasOnlyFallbackGroup() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Groupings
hasSourceType() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty
HIDDEN - Enum constant in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships
hideInternalFilter(ApplicationModule) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions

I

implementing(Class<?>) - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Helper method to create a Predicate for SpringBeans implementing the given interface.
iterator() - Method in class org.springframework.modulith.docs.ConfigurationProperties

K

keySet() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Groupings

M

matches(SpringBean) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Returns whether the given SpringBean matches the Documenter.CanvasOptions.Grouping.
ModuleProperty(String, String, String, JavaType, String) - Constructor for record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Creates an instance of a ModuleProperty record class.

N

name() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns the value of the name record component.
name() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns the value of the name record component.
nameMatching(String) - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Helper method to create a Predicate for SpringBeans matching the given name pattern.

O

of(String) - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Deprecated.
no replacement as a name-only Documenter.CanvasOptions.Grouping doesn't make any sense in the first place.
of(String, Predicate<SpringBean>) - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Creates a Documenter.CanvasOptions.Grouping with the given name and selecting Predicate.
of(String, Predicate<SpringBean>, String) - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Creates a Documenter.CanvasOptions.Grouping with the given name, selecting Predicate and description.
of(Map<String, Object>) - Static method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty
org.springframework.modulith.docs - module org.springframework.modulith.docs
org.springframework.modulith.docs - package org.springframework.modulith.docs: Documentation support for Spring Modulith.

R

renderBeanReferences(ApplicationModule) - Method in class org.springframework.modulith.docs.Asciidoctor
renderConfigurationProperties(ApplicationModule, List<ConfigurationProperties.ModuleProperty>) - Method in class org.springframework.modulith.docs.Asciidoctor
renderEvents(ApplicationModule) - Method in class org.springframework.modulith.docs.Asciidoctor
renderSpringBeans(ApplicationModule, Documenter.CanvasOptions) - Method in class org.springframework.modulith.docs.Asciidoctor
revealEmptyLines() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions: Enables table rows not containing any values to be retained in the output.
revealInternals() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions: Enables the inclusion of internal components in the module canvas.

S

sourceType() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns the value of the sourceType record component.
sourceType() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns the value of the sourceType record component.
SpringAutoRestDocsDocumentationSource - Class in org.springframework.modulith.docs: A DocumentationSource that uses metadata generated by Spring Auto REST Docs' Javadoc Doclet.
SpringAutoRestDocsDocumentationSource() - Constructor for class org.springframework.modulith.docs.SpringAutoRestDocsDocumentationSource
startOrEndTable() - Static method in class org.springframework.modulith.docs.Asciidoctor
startTable(String) - Static method in class org.springframework.modulith.docs.Asciidoctor
subtypeOf(Class<?>) - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping: Helper method to create a Predicate for SpringBeans that are a subtype of the given one.

T

toAsciidoctor(String) - Method in class org.springframework.modulith.docs.Asciidoctor
toBulletPoint(String) - Method in class org.springframework.modulith.docs.Asciidoctor
toInlineCode(JavaClass) - Method in class org.springframework.modulith.docs.Asciidoctor
toInlineCode(String) - Method in class org.springframework.modulith.docs.Asciidoctor: Turns the given source string into inline code.
toInlineCode(SpringBean) - Method in class org.springframework.modulith.docs.Asciidoctor
toModuleCanvas(ApplicationModule) - Method in class org.springframework.modulith.docs.Documenter
toModuleCanvas(ApplicationModule, String) - Method in class org.springframework.modulith.docs.Documenter
toModuleCanvas(ApplicationModule, Documenter.CanvasOptions) - Method in class org.springframework.modulith.docs.Documenter
toPlantUml() - Method in class org.springframework.modulith.docs.Documenter
toString() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns a string representation of this record class.
toString() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns a string representation of this record class.
type() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty: Returns the value of the type record component.
type() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty: Returns the value of the type record component.
typesToBulletPoints(List<JavaClass>) - Method in class org.springframework.modulith.docs.Asciidoctor

U

UML - Enum constant in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.DiagramStyle: A plain UML component diagram.

V

valueOf(String) - Static method in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.DiagramStyle: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.DiagramStyle: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships: Returns an array containing the constants of this enum class, in the order they are declared.
VISIBLE - Enum constant in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships

W

withApiBase(String) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions: Configures a URI string to act as the base of the Javadoc accessible for the types contained in the canvas.
withColorSelector(Function<ApplicationModule, Optional<String>>) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: A callback to return a hex-encoded color per ApplicationModule.
withComponentFilter(Predicate<Component>) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: A Predicate to define which Structurizr Components to be included in the diagram to be created.
withDefaultDisplayName(Function<ApplicationModule, String>) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: A callback to return a default display names for a given ApplicationModule.
withDependencyDepth(DependencyDepth) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: The DependencyDepth to define which other modules to be included in the diagram to be created.
withDependencyTypes(DependencyType...) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: Select the dependency types that are supposed to be included in the diagram to be created.
withElementsWithoutRelationships(Documenter.DiagramOptions.ElementsWithoutRelationships) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: Configuration setting to define whether modules that do not have a relationship to any other module shall be retained in the diagrams created.
withExclusions(Predicate<ApplicationModule>) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: A Predicate to define the which modules to exclude from the diagram to be created.
withJavadocBase(ApplicationModules, String) - Static method in class org.springframework.modulith.docs.Asciidoctor: Creates a new Asciidoctor instance for the given ApplicationModules and Javadoc base URI.
withoutDefaultGroupings() - Static method in class org.springframework.modulith.docs.Documenter.CanvasOptions
withoutJavadocBase(ApplicationModules) - Static method in class org.springframework.modulith.docs.Asciidoctor: Creates a new Asciidoctor instance for the given ApplicationModules.
withOutputFolder(String) - Method in class org.springframework.modulith.docs.Documenter: Deprecated, for removal: This API element is subject to removal in a future version.
use Documenter(org.springframework.modulith.core.ApplicationModules,java.lang.String) directly.
withStyle(Documenter.DiagramOptions.DiagramStyle) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: Which style to render the diagram in.
withTargetFileName(String) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions: Configures the target file name for the canvas to be written.
withTargetFileName(String) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: The target file name to be used for the diagram to be created.
withTargetOnly(Predicate<ApplicationModule>) - Method in class org.springframework.modulith.docs.Documenter.DiagramOptions: A Predicate to define which of the modules shall only be considered targets, i.e.
writeDocumentation() - Method in class org.springframework.modulith.docs.Documenter: 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. using Documenter.DiagramOptions.defaults() and Documenter.CanvasOptions.defaults().
writeDocumentation(Documenter.DiagramOptions, Documenter.CanvasOptions) - Method in class org.springframework.modulith.docs.Documenter: 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.
writeIndividualModulesAsPlantUml() - Method in class org.springframework.modulith.docs.Documenter
writeIndividualModulesAsPlantUml(Documenter.DiagramOptions) - Method in class org.springframework.modulith.docs.Documenter: Writes the component diagrams for all individual modules.
writeModuleAsPlantUml(ApplicationModule) - Method in class org.springframework.modulith.docs.Documenter: Writes the PlantUML component diagram for the given ApplicationModule.
writeModuleAsPlantUml(ApplicationModule, Documenter.DiagramOptions) - Method in class org.springframework.modulith.docs.Documenter: Writes the PlantUML component diagram for the given ApplicationModule with the given rendering Documenter.DiagramOptions.
writeModuleCanvases() - Method in class org.springframework.modulith.docs.Documenter: Writes all module canvases using Documenter.DiagramOptions.defaults().
writeModuleCanvases(Documenter.CanvasOptions) - Method in class org.springframework.modulith.docs.Documenter: Writes all module canvases using the given Documenter.DiagramOptions.
writeModulesAsPlantUml() - Method in class org.springframework.modulith.docs.Documenter: Writes the PlantUML component diagram for all ApplicationModules using Documenter.DiagramOptions.defaults().
writeModulesAsPlantUml(Documenter.DiagramOptions) - Method in class org.springframework.modulith.docs.Documenter: Writes the PlantUML component diagram for all ApplicationModules with the given Documenter.DiagramOptions.
writeTableRow(String...) - Static method in class org.springframework.modulith.docs.Asciidoctor

A B C D E F G H I K M N O R S T U V W
All Classes and Interfaces|All Packages