Uses of Class
org.springframework.modulith.core.ApplicationModule

Packages that use ApplicationModule

Package	Description
org.springframework.modulith.core	Core, internal abstractions of Spring Modulith.
org.springframework.modulith.docs	Documentation support for Spring Modulith.
org.springframework.modulith.observability	Support for application module observability.
org.springframework.modulith.observability.support	Support for application module observability.
org.springframework.modulith.test	Integration test support for Spring Modulith ApplicationModules.

Uses of ApplicationModule in org.springframework.modulith.core

Methods in org.springframework.modulith.core that return ApplicationModule

Modifier and Type	Method	Description
(package private) ApplicationModule	ApplicationModule.QualifiedDependency.getExistingModuleOf(com.tngtech.archunit.core.domain.JavaClass javaClass, ApplicationModules modules)
@Nullable ApplicationModule	ApplicationModuleDependencies.getModuleByType(String name)	Returns the ApplicationModule containing the given type.
ApplicationModule	ApplicationModule.AllowedDependency.getTargetModule()	Returns the target module of the dependency.
ApplicationModule	ApplicationModuleDependency.getTargetModule()	The target ApplicationModule.

Methods in org.springframework.modulith.core that return types with arguments of type ApplicationModule

Modifier and Type	Method	Description
Stream<ApplicationModule>	ApplicationModule.getBootstrapDependencies(ApplicationModules modules)	Returns all modules that contain types which the types of the current module depend on.
Stream<ApplicationModule>	ApplicationModule.getBootstrapDependencies(ApplicationModules modules, DependencyDepth depth)
(package private) Collection<ApplicationModule>	ApplicationModule.getDirectlyNestedModules(ApplicationModules modules)	Returns the ApplicationModules directly nested inside the current one.
Optional<ApplicationModule>	ApplicationModules.getModuleByName(String name)	Returns the ApplicationModule with the given name.
Optional<ApplicationModule>	ApplicationModules.getModuleByType(com.tngtech.archunit.core.domain.JavaClass type)	Returns the module that contains the given JavaClass.
Optional<ApplicationModule>	ApplicationModules.getModuleByType(Class<?> candidate)	Returns the ApplicationModule containing the given type.
Optional<ApplicationModule>	ApplicationModules.getModuleByType(String candidate)	Returns the ApplicationModule containing the type with the given simple or fully-qualified name.
Optional<ApplicationModule>	ApplicationModules.getModuleForPackage(String name)	Returns the ApplicationModule containing the given package.
(package private) Collection<ApplicationModule>	ApplicationModule.getNestedModules(ApplicationModules modules)	Returns all of the current ApplicationModule's nested ApplicationModules including ones contained in nested modules in turn.
Collection<ApplicationModule>	ApplicationModules.getNestedModules(ApplicationModule module)	Returns all nested modules of the given ApplicationModule.
(package private) Optional<ApplicationModule>	ApplicationModule.getParentModule(ApplicationModules modules)	Returns the current module's immediate parent module, if present.
Optional<ApplicationModule>	ApplicationModules.getParentOf(ApplicationModule module)	Returns the parent ApplicationModule if the given one has one.
Set<ApplicationModule>	ApplicationModules.getSharedModules()	Returns all ApplicationModules registered as shared ones.
Iterator<ApplicationModule>	ApplicationModules.iterator()
Stream<ApplicationModule>	ApplicationModules.stream()	Returns all ApplicationModules.
Stream<ApplicationModule>	ApplicationModuleDependencies.uniqueModules()	Returns all unique ApplicationModules involved in the dependencies.

Methods in org.springframework.modulith.core with parameters of type ApplicationModule

Modifier and Type	Method	Description
int	ApplicationModule.compareTo(ApplicationModule o)
boolean	ApplicationModuleDependencies.contains(ApplicationModule module)	Returns whether the dependencies contain the given ApplicationModule.
String	FormattableType.getAbbreviatedFullName(@Nullable ApplicationModule module)	Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.
String	FormattableType.getAbbreviatedFullName(@Nullable ApplicationModule module, FormattableType.NonModuleTypeAbbreviation abbreviation)	Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.
Collection<ApplicationModule>	ApplicationModules.getNestedModules(ApplicationModule module)	Returns all nested modules of the given ApplicationModule.
Optional<ApplicationModule>	ApplicationModules.getParentOf(ApplicationModule module)	Returns the parent ApplicationModule if the given one has one.
boolean	ApplicationModules.hasParent(ApplicationModule module)	Returns whether the given ApplicationModule has a parent one.
(package private) static ApplicationModule.AllowedDependency	ApplicationModule.AllowedDependency.of(String identifier, ApplicationModule source, ApplicationModules modules)	Creates an ApplicationModule.AllowedDependency to the module and optionally named interface defined by the given identifier.
(package private) static SpringBean	SpringBean.of(com.tngtech.archunit.core.domain.JavaClass type, ApplicationModule module)	Creates a new SpringBean for the given JavaClass and ApplicationModule.
(package private) static ApplicationModule.AllowedDependency	ApplicationModule.AllowedDependency.to(ApplicationModule module)	Creates a new ApplicationModule.AllowedDependency to the unnamed interface of the given ApplicationModule.
String	JavaAccessSource.toString(ApplicationModule module)
String	Source.toString(ApplicationModule module)	Renders the source in human readable way.

Uses of ApplicationModule in org.springframework.modulith.docs

Methods in org.springframework.modulith.docs with parameters of type ApplicationModule

Modifier and Type	Method	Description
List<ConfigurationProperties.ModuleProperty>	ConfigurationProperties.getModuleProperties(ApplicationModule module)	Returns all ConfigurationProperties.ModuleProperty instances for the given ApplicationModule.
(package private) Documenter.CanvasOptions.Groupings	Documenter.CanvasOptions.groupBeans(ApplicationModule module)
(package private) Predicate<com.tngtech.archunit.core.domain.JavaClass>	Documenter.CanvasOptions.hideInternalFilter(ApplicationModule module)
String	Asciidoctor.renderBeanReferences(ApplicationModule module)
String	Asciidoctor.renderEventsListenedTo(ApplicationModule module)
String	Asciidoctor.renderModuleDescription(ApplicationModule module)
String	Asciidoctor.renderPublishedEvents(ApplicationModule module)
String	Asciidoctor.renderSpringBeans(ApplicationModule module, Documenter.CanvasOptions options)
(package private) String	Documenter.toModuleCanvas(ApplicationModule module)
(package private) String	Documenter.toModuleCanvas(ApplicationModule module, String apiBase)
(package private) String	Documenter.toModuleCanvas(ApplicationModule module, Documenter.CanvasOptions options)
Documenter	Documenter.writeModuleAsPlantUml(ApplicationModule module)	Writes the PlantUML component diagram for the given ApplicationModule.
Documenter	Documenter.writeModuleAsPlantUml(ApplicationModule module, Documenter.DiagramOptions options)	Writes the PlantUML component diagram for the given ApplicationModule with the given rendering Documenter.DiagramOptions.

Method parameters in org.springframework.modulith.docs with type arguments of type ApplicationModule

Modifier and Type	Method	Description
Documenter.DiagramOptions	Documenter.DiagramOptions.withColorSelector(Function<ApplicationModule,Optional<String>> colorSelector)	A callback to return a hex-encoded color per ApplicationModule.
Documenter.DiagramOptions	Documenter.DiagramOptions.withDefaultDisplayName(Function<ApplicationModule,String> defaultDisplayName)	A callback to return a default display names for a given ApplicationModule.
Documenter.DiagramOptions	Documenter.DiagramOptions.withExclusions(Predicate<ApplicationModule> exclusions)	A Predicate to define the which modules to exclude from the diagram to be created.
Documenter.DiagramOptions	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.

Constructor parameters in org.springframework.modulith.docs with type arguments of type ApplicationModule

Modifier	Constructor	Description
(package private)	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, Map<String,String> skinParams)
(package private)	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, Map<String,String> skinParams)

Uses of ApplicationModule in org.springframework.modulith.observability

Methods in org.springframework.modulith.observability with parameters of type ApplicationModule

Modifier and Type	Method	Description
boolean	ObservedModule.isObservedModule(ApplicationModule module)

Uses of ApplicationModule in org.springframework.modulith.observability.support

Methods in org.springframework.modulith.observability.support with parameters of type ApplicationModule

Modifier and Type	Method	Description
boolean	DefaultObservedModule.isObservedModule(ApplicationModule module)

Constructors in org.springframework.modulith.observability.support with parameters of type ApplicationModule

Modifier	Constructor	Description
(package private)	DefaultObservedModule(ApplicationModule module)	Creates a new DefaultObservedModule for the given ApplicationModule.

Uses of ApplicationModule in org.springframework.modulith.test

Methods in org.springframework.modulith.test that return ApplicationModule

Modifier and Type	Method	Description
ApplicationModule	ModuleTestExecution.getModule()	Returns the primary ApplicationModule to bootstrap.

Methods in org.springframework.modulith.test that return types with arguments of type ApplicationModule

Modifier and Type	Method	Description
List<ApplicationModule>	ModuleTestExecution.getDependencies()	Returns all module dependencies, based on the current ApplicationModuleTest.BootstrapMode.
List<ApplicationModule>	ModuleTestExecution.getExtraIncludes()	Returns all ApplicationModules registered as extra includes for the execution.
Iterator<ApplicationModule>	ModuleTestExecution.iterator()