Index

A B C D E F G H I J K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addAdvisor(Object, Advisor) - Method in class org.springframework.modulith.observability.ModuleTracingSupport

addAdvisor(Object, Advisor, Consumer<ProxyFactory>) - Method in class org.springframework.modulith.observability.ModuleTracingSupport

additionalPackages() - Element in annotation interface org.springframework.modulith.Modulith

Defines which additional packages shall be considered as modulith base packages in addition to the one of the class carrying this annotation.

additionalPackages() - Element in annotation interface org.springframework.modulith.Modulithic

Defines which additional packages shall be considered as modulith base packages in addition to the one of the class carrying this annotation.

afterEach(ExtensionContext) - Method in class org.springframework.modulith.test.PublishedEventsParameterResolver

afterPropertiesSet() - Method in class org.springframework.modulith.events.jdbc.DatabaseSchemaInitializer

afterSingletonsInstantiated() - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster

AggregateTestUtils - Class in org.springframework.modulith.test

Test utilities to work with aggregates.

AggregateTestUtils() - Constructor for class org.springframework.modulith.test.AggregateTestUtils

ALL - Enum constant in enum class org.springframework.modulith.core.DependencyDepth

ALL_DEPENDENCIES - Enum constant in enum class org.springframework.modulith.test.ApplicationModuleTest.BootstrapMode

Bootstraps the current module as well as all upstream dependencies (including transitive ones).

allBut(Collection<DependencyType>) - Static method in enum class org.springframework.modulith.core.DependencyType

Returns all DependencyTypes except the given ones.

allBut(Stream<DependencyType>) - Static method in enum class org.springframework.modulith.core.DependencyType

allBut(DependencyType...) - Static method in enum class org.springframework.modulith.core.DependencyType

Returns all DependencyTypes except the given ones.

allFrom(JavaCodeUnit) - Static method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

allowedDependencies() - Element in annotation interface org.springframework.modulith.ApplicationModule

List the names of modules that the module is allowed to depend on.

analyze(Throwable, MissingRuntimeDependency) - Method in class org.springframework.modulith.runtime.autoconfigure.MissingRuntimeDependencyFailureAnalyzer

and() - Method in class org.springframework.modulith.test.PublishedEventsAssert.PublishedEventAssert

Syntactic sugar to start a new assertion on a different type of event.

and(RuntimeException) - Method in exception org.springframework.modulith.core.Violations

Creates a new Violations with the given RuntimeException added to the current ones?

and(String) - Method in exception org.springframework.modulith.core.Violations

and(Collection<JavaClass>) - Method in class org.springframework.modulith.core.Classes

Returns a Classes with the current elements and the given other ones combined.

and(List<NamedInterface.TypeBasedNamedInterface>) - Method in class org.springframework.modulith.core.NamedInterfaces

Creates a new NamedInterfaces instance with the given NamedInterface.TypeBasedNamedInterfaces added.

and(Classes) - Method in class org.springframework.modulith.core.Classes

and(Violations) - Method in exception org.springframework.modulith.core.Violations

andCleanup(Runnable) - Method in class org.springframework.modulith.test.Scenario.When

Registers the given Runnable as cleanup callback to always run after completion of the Scenario, no matter the outcome of its execution (error or success).

andCleanup(Consumer<T>) - Method in class org.springframework.modulith.test.Scenario.When

Registers the given Consumer as cleanup callback to always run after completion of the Scenario, no matter the outcome of its execution (error or success).

andVerify(BiConsumer<S, T>) - Method in class org.springframework.modulith.test.Scenario.When.StateChangeResult

Verifies the state change result and stimulus result using the given BiConsumer.

andVerify(Consumer<S>) - Method in class org.springframework.modulith.test.Scenario.When.StateChangeResult

Verifies the state change result using the given Consumer.

andWaitAtMost(Duration) - Method in class org.springframework.modulith.test.Scenario.When

Configures the Scenario to wait for at most the given duration for an event of the subsequent specification to arrive.

andWaitForEventOfType(Class<E>) - Method in class org.springframework.modulith.test.Scenario.When

andWaitForStateChange(Supplier<S>) - Method in class org.springframework.modulith.test.Scenario.When

Expects a particular state change on the module to produce a result.

andWaitForStateChange(Supplier<S>, Predicate<? super S>) - Method in class org.springframework.modulith.test.Scenario.When

Expects a particular state change on the module to produce a result and uses the given Predicate to determine whether the value is conclusive.

ANNOTATION_MISSING - Static variable in interface org.springframework.modulith.core.ModulithMetadata

AnnotationModulithMetadata - Class in org.springframework.modulith.core

ModulithMetadata backed by a Modulithic annotated type.

APPLICATION_LISTENER - Static variable in class org.springframework.modulith.core.Types.SpringTypes

applicationEventMulticaster(ObjectFactory<EventPublicationRegistry>) - Static method in class org.springframework.modulith.events.config.EventPublicationConfiguration

ApplicationModule - Class in org.springframework.modulith.core

An application module.

ApplicationModule - Annotation Interface in org.springframework.modulith

Annotation to customize information of a Modulith module.

ApplicationModule(JavaPackage, boolean) - Constructor for class org.springframework.modulith.core.ApplicationModule

Creates a new ApplicationModule for the given base package and whether to use fully-qualified module names.

ApplicationModule.DeclaredDependencies - Class in org.springframework.modulith.core

A collection wrapper for ApplicationModule.DeclaredDependency instances.

ApplicationModule.DeclaredDependency - Class in org.springframework.modulith.core

ApplicationModule.QualifiedDependency - Class in org.springframework.modulith.core

ApplicationModuleDependencies - Class in org.springframework.modulith.core

The materialized, in other words actually present, dependencies of the current module towards other modules.

ApplicationModuleDependency - Interface in org.springframework.modulith.core

A dependency between two ApplicationModules.

ApplicationModuleDetectionStrategies - Enum Class in org.springframework.modulith.core

Default implementations of ApplicationModuleDetectionStrategy.

ApplicationModuleDetectionStrategy - Interface in org.springframework.modulith.core

Strategy interface to customize which packages are considered module base packages.

ApplicationModuleInformation - Interface in org.springframework.modulith.core

Abstraction for low-level module information.

ApplicationModuleInformation.JMoleculesModule - Class in org.springframework.modulith.core

An ApplicationModuleInformation for the jMolecules Module annotation.

ApplicationModuleInformation.SpringModulithModule - Class in org.springframework.modulith.core

An ApplicationModuleInformation that inspects the ApplicationModule annotation.

ApplicationModuleInitializer - Interface in org.springframework.modulith

An interface to be implemented by Spring components that are supposed to be initialized on ApplicationStartedEvent.

applicationModuleInitialzingListener(ApplicationModulesRuntime, List<ApplicationModuleInitializer>) - Method in class org.springframework.modulith.runtime.autoconfigure.SpringModulithRuntimeAutoConfiguration

ApplicationModuleListener - Annotation Interface in org.springframework.modulith

An ApplicationModuleListener is an Async Spring TransactionalEventListener that runs in a transaction itself.

ApplicationModules - Class in org.springframework.modulith.core

ApplicationModules(ModulithMetadata, Collection<String>, DescribedPredicate<JavaClass>, boolean, ImportOption) - Constructor for class org.springframework.modulith.core.ApplicationModules

ApplicationModules.Filters - Class in org.springframework.modulith.core

applicationModulesEndpoint(ApplicationModulesRuntime) - Method in class org.springframework.modulith.actuator.autoconfigure.ApplicationModulesEndpointConfiguration

ApplicationModulesEndpoint - Class in org.springframework.modulith.actuator

A Spring Boot actuator endpoint to expose the application module structure of a Spring Modulith based application.

ApplicationModulesEndpoint(Supplier<ApplicationModules>) - Constructor for class org.springframework.modulith.actuator.ApplicationModulesEndpoint

Creates a new ApplicationModulesEndpoint for the given ApplicationModules.

ApplicationModulesEndpointConfiguration - Class in org.springframework.modulith.actuator.autoconfigure

Auto-configuration for the ApplicationModulesEndpoint.

ApplicationModulesEndpointConfiguration() - Constructor for class org.springframework.modulith.actuator.autoconfigure.ApplicationModulesEndpointConfiguration

ApplicationModulesExporter - Class in org.springframework.modulith.core.util

Export the structure of ApplicationModules as JSON.

ApplicationModulesExporter(ApplicationModules) - Constructor for class org.springframework.modulith.core.util.ApplicationModulesExporter

Creates a new ApplicationModulesExporter for the given ApplicationModules.

ApplicationModulesRuntime - Class in org.springframework.modulith.runtime

Bootstrap type to make sure we only bootstrap the initialization of a ApplicationModules instance once per application class.

ApplicationModulesRuntime(Supplier<ApplicationModules>, ApplicationRuntime) - Constructor for class org.springframework.modulith.runtime.ApplicationModulesRuntime

Creates a new ApplicationModulesRuntime for the given ApplicationModules and ApplicationRuntime.

ApplicationModuleTest - Annotation Interface in org.springframework.modulith.test

Bootstraps the module containing the package of the test class annotated with ApplicationModuleTest.

ApplicationModuleTest.BootstrapMode - Enum Class in org.springframework.modulith.test

ApplicationRuntime - Interface in org.springframework.modulith.runtime

Abstraction of the application runtime environment.

ArchitecturallyEvidentType - Class in org.springframework.modulith.core

A type that is architecturally relevant, i.e.

ArchitecturallyEvidentType(JavaClass) - Constructor for class org.springframework.modulith.core.ArchitecturallyEvidentType

ArchitecturallyEvidentType.DelegatingType - Class in org.springframework.modulith.core

ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType - Class in org.springframework.modulith.core

ArchitecturallyEvidentType.ReferenceMethod - Class in org.springframework.modulith.core

ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType - Class in org.springframework.modulith.core

ArchitecturallyEvidentType.SpringDataAwareArchitecturallyEvidentType - Class in org.springframework.modulith.core

ArchUnitRuntimeDependencyMissingConfiguration() - Constructor for class org.springframework.modulith.runtime.autoconfigure.SpringModulithRuntimeAutoConfiguration.ArchUnitRuntimeDependencyMissingConfiguration

areRulesPresent() - Static method in class org.springframework.modulith.core.Types.JMoleculesTypes

Asciidoctor - Class in org.springframework.modulith.docs

AssertablePublishedEvents - Interface in org.springframework.modulith.test

An AssertJ-based extension of PublishedEvents to obtain fluent assertions.

assertThat() - Method in interface org.springframework.modulith.test.AssertablePublishedEvents

asyncPropertiesDefaulter(Environment) - Static method in class org.springframework.modulith.events.config.EventPublicationConfiguration

AsyncPropertiesDefaulter(Environment) - Constructor for class org.springframework.modulith.events.config.EventPublicationConfiguration.AsyncPropertiesDefaulter

AT_ASYNC - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_AUTOWIRED - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_BEAN - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_COMPONENT - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_CONFIGURATION - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_CONFIGURATION_PROPERTIES - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_CONTROLLER - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_DOMAIN_EVENT - Static variable in class org.springframework.modulith.core.Types.JMoleculesTypes

AT_DOMAIN_EVENT_HANDLER - Static variable in class org.springframework.modulith.core.Types.JMoleculesTypes

AT_ENTITY - Static variable in class org.springframework.modulith.core.Types.JavaXTypes

AT_EVENT_LISTENER - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_INJECT - Static variable in class org.springframework.modulith.core.Types.JavaXTypes

AT_REPOSITORY - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_REPOSITORY_DEFINITION - Static variable in class org.springframework.modulith.core.Types.SpringDataTypes

AT_RESOURCE - Static variable in class org.springframework.modulith.core.Types.JavaXTypes

AT_SERVICE - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_SPRING_BOOT_APPLICATION - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AT_TX_EVENT_LISTENER - Static variable in class org.springframework.modulith.core.Types.SpringTypes

AutoConfigurationAndEntityScanPackageCustomizer() - Constructor for class org.springframework.modulith.test.ModuleTestAutoConfiguration.AutoConfigurationAndEntityScanPackageCustomizer

B

beforeAll(ExtensionContext) - Method in class org.springframework.modulith.test.PublishedEventsParameterResolver

beforeAll(ExtensionContext) - Method in class org.springframework.modulith.test.ScenarioParameterResolver

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

Classes - Class in org.springframework.modulith.core

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.

compareTo(EventPublication) - Method in interface org.springframework.modulith.events.EventPublication

CompletableEventPublication - Interface in org.springframework.modulith.events

An event publication that can be completed.

completionDate - Variable in class org.springframework.modulith.events.jpa.JpaEventPublication

completionDate - Variable in class org.springframework.modulith.events.mongodb.MongoDbEventPublication

completionRegisteringAdvisor(ObjectFactory<EventPublicationRegistry>) - Static method in class org.springframework.modulith.events.config.EventPublicationConfiguration

CompletionRegisteringAdvisor - Class in org.springframework.modulith.events.support

An Advisor to decorate TransactionalEventListener annotated methods to mark the previously registered event publications as completed on successful method execution.

CompletionRegisteringAdvisor(Supplier<EventPublicationRegistry>) - Constructor for class org.springframework.modulith.events.support.CompletionRegisteringAdvisor

Creates a new CompletionRegisteringAdvisor for the given EventPublicationRegistry.

CompletionRegisteringAdvisor.CompletionRegisteringMethodInterceptor - Class in org.springframework.modulith.events.support

MethodInterceptor to trigger the completion of an event publication after a transaction event listener method has been completed successfully.

CompletionRegisteringMethodInterceptor(Supplier<EventPublicationRegistry>) - Constructor for class org.springframework.modulith.events.support.CompletionRegisteringAdvisor.CompletionRegisteringMethodInterceptor

Creates a new CompletionRegisteringAdvisor.CompletionRegisteringMethodInterceptor for the given EventPublicationRegistry.

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.

contains(JavaClass) - Method in class org.springframework.modulith.core.ApplicationModule

contains(JavaClass) - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependencies

Returns whether any of the dependencies contains the given JavaClass.

contains(JavaClass) - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependency

Returns whether the ApplicationModule.DeclaredDependency contains the given JavaClass.

contains(JavaClass) - Method in class org.springframework.modulith.core.ApplicationModules

Returns whether the given JavaClass is contained within the ApplicationModules.

contains(JavaClass) - Method in class org.springframework.modulith.core.Classes

contains(JavaClass) - Method in class org.springframework.modulith.core.JavaPackage

Return whether the JavaPackage contains the given type.

contains(JavaClass) - Method in class org.springframework.modulith.core.NamedInterface

Returns whether the NamedInterface contains the given JavaClass.

contains(Class<?>) - Method in class org.springframework.modulith.core.ApplicationModule

contains(Class<?>) - Method in class org.springframework.modulith.core.NamedInterface

Returns whether the NamedInterface contains the given type.

contains(Class<T>) - Method in class org.springframework.modulith.test.PublishedEventsAssert

Asserts that the PublishedEvents contain at least one event of the given type.

contains(String) - Method in class org.springframework.modulith.core.ApplicationModule

Returns whether the given module contains a type with the given simple or fully qualified name.

contains(String) - Method in class org.springframework.modulith.core.Classes

contains(String) - Method in class org.springframework.modulith.core.JavaPackage

Returns whether the JavaPackage contains the type with the given name.

contains(LocalDate) - Method in class org.springframework.modulith.moments.ShiftedQuarter

Returns whether the given LocalDate is contained in the current ShiftedQuarter.

contains(ApplicationModule) - Method in class org.springframework.modulith.core.ApplicationModuleDependencies

Returns whether the dependencies contain the given ApplicationModule.

containsModuleNamed(String) - Method in class org.springframework.modulith.core.ApplicationModuleDependencies

Returns whether the dependencies contain the ApplicationModule with the given name.

create(EventPublication) - Method in interface org.springframework.modulith.events.EventPublicationRepository

Persists the given EventPublication.

create(EventPublication) - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

create(EventPublication) - Method in class org.springframework.modulith.events.jpa.JpaEventPublicationRepository

create(EventPublication) - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublicationRepository

createContextCustomizer(Class<?>, List<ContextConfigurationAttributes>) - Method in class org.springframework.modulith.test.ModuleContextCustomizerFactory

customize(Function<ConditionFactory, ConditionFactory>) - Method in class org.springframework.modulith.test.Scenario.When

customizeContext(ConfigurableApplicationContext, MergedContextConfiguration) - Method in class org.springframework.modulith.test.ModuleContextCustomizerFactory.ModuleContextCustomizer

D

databaseSchemaInitializer(JdbcTemplate, ResourceLoader, DatabaseType) - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationAutoConfiguration

DatabaseSchemaInitializer - Class in org.springframework.modulith.events.jdbc

Initializes the DB schema used to store events

DatabaseSchemaInitializer(JdbcOperations, ResourceLoader, DatabaseType) - Constructor for class org.springframework.modulith.events.jdbc.DatabaseSchemaInitializer

Creates a new DatabaseSchemaInitializer for the given JdbcOperations, ResourceLoader and DatabaseType.

databaseToUUID(Object) - Method in enum class org.springframework.modulith.events.jdbc.DatabaseType

databaseType(DataSource) - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationAutoConfiguration

DatabaseType - Enum Class in org.springframework.modulith.events.jdbc

DayHasPassed - Class in org.springframework.modulith.moments

A DomainEvent published on each day.

DAYS - Enum constant in enum class org.springframework.modulith.moments.support.MomentsProperties.Granularity

Publish daily events only.

DeclaredDependencies(List<ApplicationModule.DeclaredDependency>) - Constructor for class org.springframework.modulith.core.ApplicationModule.DeclaredDependencies

Creates a new ApplicationModule.DeclaredDependencies for the given List of ApplicationModule.DeclaredDependency.

DEFAULT - Enum constant in enum class org.springframework.modulith.core.DependencyType

DefaultAssertablePublishedEvents - Class in org.springframework.modulith.test

Default implementation of AssertablePublishedEvents.

DefaultAssertablePublishedEvents() - Constructor for class org.springframework.modulith.test.DefaultAssertablePublishedEvents

Creates a new DefaultAssertablePublishedEvents.

DefaultAssertablePublishedEvents(DefaultPublishedEvents) - Constructor for class org.springframework.modulith.test.DefaultAssertablePublishedEvents

Creates a new DefaultAssertablePublishedEvents with the given DefaultPublishedEvents delegate.

DefaultEventPublication - Class in org.springframework.modulith.events

Default CompletableEventPublication implementation.

DefaultEventPublication(Object, PublicationTargetIdentifier) - Constructor for class org.springframework.modulith.events.DefaultEventPublication

Creates a new DefaultEventPublication for the given event and PublicationTargetIdentifier.

DefaultEventPublicationRegistry - Class in org.springframework.modulith.events

A registry to capture event publications to ApplicationListeners.

DefaultEventPublicationRegistry(EventPublicationRepository) - Constructor for class org.springframework.modulith.events.DefaultEventPublicationRegistry

Creates a new DefaultEventPublicationRegistry for the given EventPublicationRepository.

DefaultObservedModule - Class in org.springframework.modulith.observability

DefaultObservedModule(ApplicationModule) - Constructor for class org.springframework.modulith.observability.DefaultObservedModule

Creates a new DefaultObservedModule for the given ApplicationModule.

defaultOr(Supplier<DependencyType>) - Method in enum class org.springframework.modulith.core.DependencyType

Returns the current DependencyType or obtains the one provided by the given supplier if the current one is DependencyType.DEFAULT.

DefaultPublishedEvents - Class in org.springframework.modulith.test

Default implementation of PublishedEvents.

DefaultPublishedEvents() - Constructor for class org.springframework.modulith.test.DefaultPublishedEvents

Creates a new, empty DefaultPublishedEvents instance.

DefaultPublishedEvents(Collection<? extends Object>) - Constructor for class org.springframework.modulith.test.DefaultPublishedEvents

Creates a new DefaultPublishedEvents instance with the given events.

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.

DEFAULTS - Static variable in class org.springframework.modulith.moments.support.MomentsProperties

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.

DelegatingType(JavaClass, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Boolean>, Supplier<Collection<JavaClass>>, Supplier<Collection<ArchitecturallyEvidentType.ReferenceMethod>>) - Constructor for class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

deleteCompletedPublications() - Method in interface org.springframework.modulith.events.EventPublicationRepository

Deletes all publications that were already marked as completed.

deleteCompletedPublications() - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

deleteCompletedPublications() - Method in class org.springframework.modulith.events.jpa.JpaEventPublicationRepository

deleteCompletedPublications() - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublicationRepository

DependencyDepth - Enum Class in org.springframework.modulith.core

DependencyType - Enum Class in org.springframework.modulith.core

The type of dependency between ApplicationModules.

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.

deserialize(Object, Class<T>) - Method in interface org.springframework.modulith.events.EventSerializer

Deserializes the event from the serialization format into an instance of the given type.

deserialize(Object, Class<T>) - Method in class org.springframework.modulith.events.jackson.JacksonEventSerializer

destroy() - Method in class org.springframework.modulith.events.DefaultEventPublicationRegistry

detectDependencies(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule

detectViolations() - Method in class org.springframework.modulith.core.ApplicationModules

Executes all verifications to be applied and returns Violations if any occured.

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

DIRECT_DEPENDENCIES - Enum constant in enum class org.springframework.modulith.test.ApplicationModuleTest.BootstrapMode

Bootstraps the current module as well as its direct dependencies.

DIRECT_SUB_PACKAGES - Enum constant in enum class org.springframework.modulith.core.ApplicationModuleDetectionStrategies

directSubPackage() - Static method in interface org.springframework.modulith.core.ApplicationModuleDetectionStrategy

A ApplicationModuleDetectionStrategy that considers all direct sub-packages of the Moduliths base package to be module base packages.

discoverNamedInterfaces(JavaPackage) - Static method in class org.springframework.modulith.core.NamedInterfaces

Discovers all NamedInterfaces declared for the given JavaPackage.

displayName() - Element in annotation interface org.springframework.modulith.ApplicationModule

The human readable name of the module to be used for display and documentation purposes.

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.

DOMAIN_EVENT - Static variable in class org.springframework.modulith.core.Types.JMoleculesTypes

doWithListener(String, Consumer<TransactionalApplicationListener<ApplicationEvent>>) - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster.TransactionalEventListeners

Invokes the given Consumer for the listener with the given identifier.

E

EnablePersistentDomainEvents - Annotation Interface in org.springframework.modulith.events.config

EnablePersistentDomainEvents.PersistentDomainEventsImportSelector - Class in org.springframework.modulith.events.config

ENTITY - Enum constant in enum class org.springframework.modulith.core.DependencyType

Indicates that the module refers to an entity of the other.

equals(Object) - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependencies

equals(Object) - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependency

equals(Object) - Method in class org.springframework.modulith.core.ApplicationModule

equals(Object) - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

equals(Object) - Method in class org.springframework.modulith.core.Classes

equals(Object) - Method in class org.springframework.modulith.core.EventType

equals(Object) - Method in class org.springframework.modulith.core.JavaPackage

equals(Object) - Method in class org.springframework.modulith.core.SpringBean

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.

equals(Object) - Method in class org.springframework.modulith.events.DefaultEventPublication

equals(Object) - Method in class org.springframework.modulith.events.PublicationTargetIdentifier

equals(Object) - Method in class org.springframework.modulith.moments.DayHasPassed

equals(Object) - Method in class org.springframework.modulith.moments.HourHasPassed

equals(Object) - Method in class org.springframework.modulith.moments.MonthHasPassed

equals(Object) - Method in class org.springframework.modulith.moments.QuarterHasPassed

equals(Object) - Method in class org.springframework.modulith.moments.ShiftedQuarter

equals(Object) - Method in class org.springframework.modulith.moments.WeekHasPassed

equals(Object) - Method in class org.springframework.modulith.moments.YearHasPassed

equals(Object) - Method in class org.springframework.modulith.test.ModuleContextCustomizerFactory.ModuleContextCustomizer

equals(Object) - Method in class org.springframework.modulith.test.ModuleTestExecution

equals(Object) - Method in class org.springframework.modulith.test.ModuleTypeExcludeFilter

event - Variable in class org.springframework.modulith.events.mongodb.MongoDbEventPublication

EVENT_LISTENER - Enum constant in enum class org.springframework.modulith.core.DependencyType

Indicates that the module depends on the other by declaring an event listener for an event exposed by the other module.

eventOfTypeWasPublished(Class<?>) - Method in interface org.springframework.modulith.test.TypedEvents

Returns whether an event of the given type was published.

EventPublication - Interface in org.springframework.modulith.events

An event publication.

EventPublicationConfiguration - Class in org.springframework.modulith.events.config

EventPublicationConfiguration() - Constructor for class org.springframework.modulith.events.config.EventPublicationConfiguration

EventPublicationConfiguration.AsyncPropertiesDefaulter - Class in org.springframework.modulith.events.config

EventPublicationConfigurationExtension - Interface in org.springframework.modulith.events.config

eventPublicationRegistry(EventPublicationRepository) - Method in class org.springframework.modulith.events.config.EventPublicationConfiguration

EventPublicationRegistry - Interface in org.springframework.modulith.events

A registry to capture event publications to ApplicationListeners.

EventPublicationRepository - Interface in org.springframework.modulith.events

Repository to store EventPublications.

EventResult(Class<E>, Function<PublishedEvents.TypedPublishedEvents<E>, PublishedEvents.TypedPublishedEvents<E>>) - Constructor for class org.springframework.modulith.test.Scenario.When.EventResult

Creates a new Scenario.When.EventResult for the given type and filter.

EventSerializationConfigurationExtension - Interface in org.springframework.modulith.events.config

EventSerializer - Interface in org.springframework.modulith.events

eventsOf(Object) - Static method in class org.springframework.modulith.test.AggregateTestUtils

Extracts all domain events from the given aggregate that uses Spring Data's DomainEvents annotation to expose them.

eventType - Variable in class org.springframework.modulith.events.jpa.JpaEventPublication

EventType - Class in org.springframework.modulith.core

A type that represents an event in a system.

EventType(JavaClass) - Constructor for class org.springframework.modulith.core.EventType

Creates a new EventType for the given JavaClass.

everyHour() - Method in class org.springframework.modulith.moments.support.Moments

Triggers event publication every hour.

everyMidnight() - Method in class org.springframework.modulith.moments.support.Moments

Triggers event publication every midnight.

EXPLICITLY_ANNOTATED - Enum constant in enum class org.springframework.modulith.core.ApplicationModuleDetectionStrategies

explictlyAnnotated() - Static method in interface org.springframework.modulith.core.ApplicationModuleDetectionStrategy

A ApplicationModuleDetectionStrategy that considers packages explicitly annotated with ApplicationModule module base packages.

exposes(JavaClass) - Method in class org.springframework.modulith.observability.DefaultObservedModule

exposes(JavaClass) - Method in interface org.springframework.modulith.observability.ObservedModule

Returns whether the ObservedModule exposes the given JavaClass.

extraIncludes() - Element in annotation interface org.springframework.modulith.test.ApplicationModuleTest

Module names of modules to be included in the test run independent of what the ApplicationModuleTest.mode() defines.

F

FALLBACK_GROUP - Static variable in class org.springframework.modulith.docs.Documenter.CanvasOptions

Filters() - Constructor for class org.springframework.modulith.core.ApplicationModules.Filters

findIncompletePublications() - Method in class org.springframework.modulith.events.DefaultEventPublicationRegistry

findIncompletePublications() - Method in interface org.springframework.modulith.events.EventPublicationRegistry

Returns all EventPublications that have not been completed yet.

findIncompletePublications() - Method in interface org.springframework.modulith.events.EventPublicationRepository

Returns all EventPublication that have not been completed yet.

findIncompletePublications() - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

findIncompletePublications() - Method in class org.springframework.modulith.events.jpa.JpaEventPublicationRepository

findIncompletePublications() - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublicationRepository

findIncompletePublicationsByEventAndTargetIdentifier(Object, PublicationTargetIdentifier) - Method in interface org.springframework.modulith.events.EventPublicationRepository

Return the incomplete EventPublication for the given serialized event and listener identifier.

findIncompletePublicationsByEventAndTargetIdentifier(Object, PublicationTargetIdentifier) - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

findIncompletePublicationsByEventAndTargetIdentifier(Object, PublicationTargetIdentifier) - Method in class org.springframework.modulith.events.jpa.JpaEventPublicationRepository

findIncompletePublicationsByEventAndTargetIdentifier(Object, PublicationTargetIdentifier) - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublicationRepository

forCodeUnit(JavaCodeUnit) - Static method in enum class org.springframework.modulith.core.DependencyType

forDependency(Dependency) - Static method in enum class org.springframework.modulith.core.DependencyType

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

forEach(Consumer<TransactionalApplicationListener<?>>) - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster.TransactionalEventListeners

Invokes the given Consumer for all transactional event listeners.

forEventOfType(Class<E>) - Method in class org.springframework.modulith.test.Scenario.When

Alternative to Scenario.When.andWaitForEventOfType(Class) for better readability if execution customizations have been applied before.

format() - Method in class org.springframework.modulith.core.Classes

format(JavaClass, String) - Static method in class org.springframework.modulith.core.Classes

format(String) - Method in class org.springframework.modulith.core.Classes

format(FormatableType, FormatableType) - Method in enum class org.springframework.modulith.core.DependencyType

FormatableType - Class in org.springframework.modulith.core

Wrapper around JavaClass that allows creating additional formatted names.

forParameter(JavaClass) - Static method in enum class org.springframework.modulith.core.DependencyType

forPhase(TransactionPhase) - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster.TransactionalEventListeners

Returns all PersistentApplicationEventMulticaster.TransactionalEventListeners for the given TransactionPhase.

forStateChange(Supplier<S>) - Method in class org.springframework.modulith.test.Scenario.When

Alternative to Scenario.When.andWaitForStateChange(Supplier) for better readability if execution customizations have been applied before.

forStateChange(Supplier<S>, Predicate<? super S>) - Method in class org.springframework.modulith.test.Scenario.When

Alternative to Scenario.When.andWaitForStateChange(Supplier, Predicate) for better readability if execution customizations have been applied before.

from(DatabaseDriver) - Static method in enum class org.springframework.modulith.events.jdbc.DatabaseType

fromCodeUnitParameter(JavaCodeUnit, JavaClass) - Static method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

fromCodeUnitReturnType(JavaCodeUnit) - Static method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

fromType(ArchitecturallyEvidentType) - Static method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

G

get() - Method in class org.springframework.modulith.runtime.ApplicationModulesRuntime

getAbbreviatedFullName() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Returns the abbreviated (i.e.

getAbbreviatedFullName() - Method in class org.springframework.modulith.core.FormatableType

Returns the abbreviated (i.e.

getAbbreviatedFullName(ApplicationModule) - Method in class org.springframework.modulith.core.FormatableType

Returns the abbreviated full name of the type abbreviating only the part of the given ApplicationModule's base package.

getAdditionalPackages() - Method in class org.springframework.modulith.core.AnnotationModulithMetadata

getAdditionalPackages() - Method in interface org.springframework.modulith.core.ModulithMetadata

Returns the names of the packages that are supposed to be considered modulith base packages, i.e.

getAdditionalPackages() - Method in class org.springframework.modulith.core.SpringBootModulithMetadata

getAdvice() - Method in class org.springframework.modulith.events.support.CompletionRegisteringAdvisor

getAggregateRoots() - Method in class org.springframework.modulith.core.ApplicationModule

Returns all types that are considered aggregate roots.

getAllowedDependencies() - Method in interface org.springframework.modulith.core.ApplicationModuleInformation

Returns all allowed dependencies.

getAllowedDependencies() - Method in class org.springframework.modulith.core.ApplicationModuleInformation.JMoleculesModule

getAllowedDependencies() - Method in class org.springframework.modulith.core.ApplicationModuleInformation.SpringModulithModule

getAllowedDependencies(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule

Returns all allowed module dependencies, either explicitly declared or defined as shared on the given ApplicationModules instance.

getAnnotation(Class<A>) - Method in class org.springframework.modulith.core.JavaPackage

Return the annotation of the given type declared on the package.

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

getApplicationEvent() - Method in interface org.springframework.modulith.events.EventPublication

Returns the event as Spring ApplicationEvent, effectively wrapping it into a PayloadApplicationEvent in case it's not one already.

getApplicationModules() - Method in class org.springframework.modulith.actuator.ApplicationModulesEndpoint

Returns the ApplicationModules metadata as Map (to be rendered as JSON).

getArchitecturallyEvidentType(Class<?>) - Method in class org.springframework.modulith.core.ApplicationModule

Returns the ArchitecturallyEvidentType for the given type.

getBasePackage() - Method in class org.springframework.modulith.core.ApplicationModule

Returns the module's base package.

getBasePackages() - Method in class org.springframework.modulith.test.ModuleTestExecution

Returns all base packages the current execution needs to use for component scanning, auto-configuration etc.

getBootstrapBasePackages(ApplicationModules, DependencyDepth) - Method in class org.springframework.modulith.core.ApplicationModule

Returns all JavaPackage for the current module including the ones by its dependencies.

getBootstrapDependencies(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule

Returns all modules that contain types which the types of the current module depend on.

getBootstrapDependencies(ApplicationModules, DependencyDepth) - Method in class org.springframework.modulith.core.ApplicationModule

getBootstrapMode() - Method in class org.springframework.modulith.test.ModuleTestExecution

Returns the ApplicationModuleTest.BootstrapMode to be used for the executions.

getByName(String) - Method in class org.springframework.modulith.core.NamedInterfaces

Returns the NamedInterface with the given name if present.

getClasses() - Method in class org.springframework.modulith.core.JavaPackage

Returns all classes residing in the current package and potentially in sub-packages if the current package was created to include them.

getClasses() - Method in class org.springframework.modulith.core.NamedInterface

Returns all Classes making up this NamedInterface.

getClasses() - Method in class org.springframework.modulith.core.NamedInterface.TypeBasedNamedInterface

getComparator() - Method in class org.springframework.modulith.core.ApplicationModules

Returns a Comparator that will sort objects based on their types' application module.

getCompletionDate() - Method in interface org.springframework.modulith.events.CompletableEventPublication

Returns the completion date of the publication.

getCompletionDate() - Method in class org.springframework.modulith.events.DefaultEventPublication

getDate() - Method in class org.springframework.modulith.moments.DayHasPassed

The day that has just passed.

getDependencies() - Method in class org.springframework.modulith.test.ModuleTestExecution

Returns all module dependencies, based on the current ApplicationModuleTest.BootstrapMode.

getDependencies(ApplicationModules, DependencyType...) - Method in class org.springframework.modulith.core.ApplicationModule

Returns ApplicationModule.DeclaredDependencies of the current ApplicationModule.

getDependencyType() - Method in interface org.springframework.modulith.core.ApplicationModuleDependency

The type of the dependency.

getDepth() - Method in enum class org.springframework.modulith.test.ApplicationModuleTest.BootstrapMode

Returns the DependencyDepth associated with the ApplicationModuleTest.BootstrapMode.

getDescription() - Method in class org.springframework.modulith.core.Classes

getDescription() - Method in class org.springframework.modulith.core.JavaPackage

getDescription() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping

Returns the description of the Documenter.CanvasOptions.Grouping.

getDescription() - Method in exception org.springframework.modulith.runtime.autoconfigure.MissingRuntimeDependency

getDirectSubPackages() - Method in class org.springframework.modulith.core.JavaPackage

Returns all direct sub-packages of the current one.

getDisplayName() - Method in class org.springframework.modulith.core.ApplicationModule

Returns the name of the ApplicationModule for display purposes.

getDisplayName() - Method in interface org.springframework.modulith.core.ApplicationModuleInformation

Returns the display name to be used to describe the module.

getDisplayName() - Method in class org.springframework.modulith.core.ApplicationModuleInformation.JMoleculesModule

getDisplayName() - Method in class org.springframework.modulith.core.ApplicationModuleInformation.SpringModulithModule

getDisplayName() - Method in class org.springframework.modulith.observability.DefaultObservedModule

getDisplayName() - Method in interface org.springframework.modulith.observability.ObservedModule

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

getEnd() - Method in enum class org.springframework.modulith.moments.Quarter

Returns the end MonthDay.

getEnd() - Method in class org.springframework.modulith.moments.ShiftedQuarter

getEndDate() - Method in class org.springframework.modulith.moments.QuarterHasPassed

Returns the date of the last day of the quarter that has just passed.

getEndDate() - Method in class org.springframework.modulith.moments.WeekHasPassed

Returns the end date of the week that has passed.

getEndDate() - Method in class org.springframework.modulith.moments.YearHasPassed

Returns the end date of the year passed.

getEndDate(Year) - Method in class org.springframework.modulith.moments.ShiftedQuarter

Returns the end date of the ShiftedQuarter for the given Year.

getEvent() - Method in class org.springframework.modulith.events.DefaultEventPublication

getEvent() - Method in interface org.springframework.modulith.events.EventPublication

Returns the event that is published.

getEventsListenedTo(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule

Returns all event types the current module exposes an event listener for.

getExistingModuleOf(JavaClass, ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

getExtraIncludes() - Method in class org.springframework.modulith.test.ModuleTestExecution

Returns all ApplicationModules registered as extra includes for the execution.

getFullName() - Method in class org.springframework.modulith.core.FormatableType

Returns the type's full name.

getFullyQualifiedTypeName() - Method in class org.springframework.modulith.core.SpringBean

Returns the fully-qualified name of the Spring bean type.

getId() - Method in interface org.springframework.modulith.runtime.ApplicationRuntime

Returns the identifier of the application.

getId() - Method in class org.springframework.modulith.runtime.autoconfigure.SpringBootApplicationRuntime

getInterfacesWithinModule() - Method in class org.springframework.modulith.core.SpringBean

Returns all interfaces implemented by the bean that are part of the same application module.

getInvokedMethod(MethodInvocation) - Method in class org.springframework.modulith.observability.DefaultObservedModule

getInvokedMethod(MethodInvocation) - Method in interface org.springframework.modulith.observability.ObservedModule

Returns the name of the actually invoked Method.

getLocale() - Method in class org.springframework.modulith.moments.support.MomentsProperties

The Locale to use when determining week boundaries.

getLocale() - Method in class org.springframework.modulith.moments.WeekHasPassed

getLocalName() - Method in class org.springframework.modulith.core.JavaPackage

Returns the local name of the package, i.e.

getMainApplicationClass() - Method in interface org.springframework.modulith.runtime.ApplicationRuntime

Returns the primary application class.

getMainApplicationClass() - Method in class org.springframework.modulith.runtime.autoconfigure.SpringBootApplicationRuntime

getMessage() - Method in exception org.springframework.modulith.core.Violations

getMethod() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.ReferenceMethod

getMethodsToIntercept() - Method in class org.springframework.modulith.observability.ObservedModuleType

Returns a predicate to filter the methods to intercept.

getModule() - Method in class org.springframework.modulith.test.ModuleTestExecution

Returns the primary ApplicationModule to bootstrap.

getModuleAnnotationTypeIfPresent() - Static method in class org.springframework.modulith.core.Types.JMoleculesTypes

getModuleBasePackages(JavaPackage) - Method in interface org.springframework.modulith.core.ApplicationModuleDetectionStrategy

Given the JavaPackage that Moduliths was initialized with, return the base packages for all modules in the system.

getModuleByName(String) - Method in class org.springframework.modulith.core.ApplicationModules

Returns the ApplicationModule with the given name.

getModuleByType(JavaClass) - Method in class org.springframework.modulith.core.ApplicationModules

Returns the module that contains the given JavaClass.

getModuleByType(Class<?>) - Method in class org.springframework.modulith.core.ApplicationModules

Returns the ApplicationModule containing the given type.

getModuleByType(String) - Method in class org.springframework.modulith.core.ApplicationModules

Returns the ApplicationModule containing the type with the given simple or fully-qualified name.

getModuleForPackage(String) - Method in class org.springframework.modulith.core.ApplicationModules

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

getModules() - Method in class org.springframework.modulith.test.ModuleTestExecution

Returns all ApplicationModules of the application.

getModulithSource() - Method in class org.springframework.modulith.core.AnnotationModulithMetadata

getModulithSource() - Method in class org.springframework.modulith.core.ApplicationModules

Deprecated, for removal: This API element is subject to removal in a future version.

use ApplicationModules.getSource() instead

getModulithSource() - Method in interface org.springframework.modulith.core.ModulithMetadata

Deprecated, for removal: This API element is subject to removal in a future version.

use ModulithMetadata.getSource() instead.

getModulithSource() - Method in class org.springframework.modulith.core.SpringBootModulithMetadata

getMonth() - Method in class org.springframework.modulith.moments.MonthHasPassed

The month that has just passed.

getName() - Method in class org.springframework.modulith.core.ApplicationModule

Returns the logical name of the module.

getName() - Method in class org.springframework.modulith.core.JavaPackage

Returns the name of the package.

getName() - Method in class org.springframework.modulith.core.NamedInterface

Returns the NamedInterface's name.

getName() - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping

Returns the name of the Documenter.CanvasOptions.Grouping.

getName() - Method in class org.springframework.modulith.observability.DefaultObservedModule

getName() - Method in interface org.springframework.modulith.observability.ObservedModule

getNamedInterfaces() - Method in class org.springframework.modulith.core.ApplicationModule

Returns all NamedInterfaces exposed by the module.

getObservedModuleType(Class<?>, ApplicationModules) - Method in class org.springframework.modulith.observability.DefaultObservedModule

getObservedModuleType(Class<?>, ApplicationModules) - Method in interface org.springframework.modulith.observability.ObservedModule

Returns the ObservedModuleType for the given type and ApplicationModules.

getOrder() - Method in class org.springframework.modulith.events.support.CompletionRegisteringAdvisor.CompletionRegisteringMethodInterceptor

getPointcut() - Method in class org.springframework.modulith.events.support.CompletionRegisteringAdvisor

getPublicationDate() - Method in class org.springframework.modulith.events.DefaultEventPublication

getPublicationDate() - Method in interface org.springframework.modulith.events.EventPublication

Returns the time the event is published at.

getPublishedEvents() - Method in class org.springframework.modulith.core.ApplicationModule

Returns all EventTypes published by the module.

getQuarter() - Method in class org.springframework.modulith.moments.ShiftedQuarter

Returns the logical Quarter.

getReferenceMethods() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

getReferenceMethods() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

getReferenceMethods() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

getReferenceTypes() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

getReferenceTypes() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Returns other types that are interesting in the context of the current ArchitecturallyEvidentType.

getReferenceTypes() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

getRequiredClass(Class<?>) - Method in class org.springframework.modulith.core.Classes

getSchemaResourceFilename() - Method in enum class org.springframework.modulith.events.jdbc.DatabaseType

getSharedModuleNames() - Method in class org.springframework.modulith.core.AnnotationModulithMetadata

getSharedModuleNames() - Method in interface org.springframework.modulith.core.ModulithMetadata

Returns the name of shared modules, i.e.

getSharedModuleNames() - Method in class org.springframework.modulith.core.SpringBootModulithMetadata

getSharedModules() - Method in class org.springframework.modulith.core.ApplicationModules

Returns all ApplicationModules registered as shared ones.

getShiftedQuarter(LocalDate) - Method in class org.springframework.modulith.moments.support.MomentsProperties

Returns the ShiftedQuarter for the given reference date.

getSource() - Method in class org.springframework.modulith.core.AnnotationModulithMetadata

getSource() - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

Returns the source JavaClass.

getSource() - Method in class org.springframework.modulith.core.ApplicationModules

Returns the source of the ApplicationModules.

getSource() - Method in interface org.springframework.modulith.core.ModulithMetadata

Returns the source of the Spring Modulith setup.

getSource() - Method in class org.springframework.modulith.core.SpringBootModulithMetadata

getSources() - Method in class org.springframework.modulith.core.EventType

The sources that create that event.

getSourceType() - Method in interface org.springframework.modulith.core.ApplicationModuleDependency

The source java type establishing the dependency.

getSpringBeans() - Method in class org.springframework.modulith.core.ApplicationModule

Returns all SpringBeans contained in the module.

getSpringBeansInternal() - Method in class org.springframework.modulith.core.ApplicationModule

getStart() - Method in enum class org.springframework.modulith.moments.Quarter

Returns the start MonthDay.

getStart() - Method in class org.springframework.modulith.moments.ShiftedQuarter

getStartDate() - Method in class org.springframework.modulith.moments.QuarterHasPassed

Returns the date of the first day of the quarter that has just passed.

getStartDate() - Method in class org.springframework.modulith.moments.WeekHasPassed

Returns the start date of the week that has passed.

getStartDate() - Method in class org.springframework.modulith.moments.YearHasPassed

Returns the start date of the year passed.

getStartDate(Year) - Method in class org.springframework.modulith.moments.ShiftedQuarter

Returns the start date of the ShiftedQuarter for the given Year.

getSubPackagesAnnotatedWith(Class<? extends Annotation>) - Method in class org.springframework.modulith.core.JavaPackage

Returns all sub-packages that carry the given annotation type.

getSuggestedAction() - Method in exception org.springframework.modulith.runtime.autoconfigure.MissingRuntimeDependency

getSystemName() - Method in class org.springframework.modulith.core.AnnotationModulithMetadata

getSystemName() - Method in class org.springframework.modulith.core.ApplicationModules

Returns the system name if defined.

getSystemName() - Method in interface org.springframework.modulith.core.ModulithMetadata

Returns the name of the system.

getSystemName() - Method in class org.springframework.modulith.core.SpringBootModulithMetadata

getTarget() - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

Returns the target JavaClass.

getTargetIdentifier() - Method in class org.springframework.modulith.events.DefaultEventPublication

getTargetIdentifier() - Method in interface org.springframework.modulith.events.EventPublication

Returns the identifier of the target that the event is supposed to be published to.

getTargetModule() - Method in interface org.springframework.modulith.core.ApplicationModuleDependency

The target ApplicationModule.

getTargetType() - Method in interface org.springframework.modulith.core.ApplicationModuleDependency

The dependency target type.

getTime() - Method in class org.springframework.modulith.moments.HourHasPassed

The hour that has just passed.

getTransactionPhase() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.ReferenceMethod

getType() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Returns the JavaClass backing the ArchitecturallyEvidentType.

getType() - Method in class org.springframework.modulith.core.EventType

The JavaClass of the EventType.

getType() - Method in class org.springframework.modulith.core.SpringBean

Returns the JavaClass of the SpringBean.

getType(String) - Method in class org.springframework.modulith.core.ApplicationModule

Returns the JavaClass for the given candidate simple of fully-qualified type name.

getUnnamedInterface() - Method in class org.springframework.modulith.core.NamedInterfaces

Returns the unnamed NamedInterface of the module.

getUserClass(Object, String) - Method in class org.springframework.modulith.runtime.ApplicationModulesRuntime

Returns the actual user class for a given bean and bean name.

getUserClass(Object, String) - Method in interface org.springframework.modulith.runtime.ApplicationRuntime

Obtain the end user class for the given bean and bean name.

getUserClass(Object, String) - Method in class org.springframework.modulith.runtime.autoconfigure.SpringBootApplicationRuntime

getValue() - Method in class org.springframework.modulith.events.PublicationTargetIdentifier

Returns the raw String value of the identifier.

getValueTypes() - Method in class org.springframework.modulith.core.ApplicationModule

Returns all value types contained in the module.

getWeek() - Method in class org.springframework.modulith.moments.WeekHasPassed

The Locale to be used to calculate the start date of the week.

getYear() - Method in class org.springframework.modulith.moments.WeekHasPassed

The year of the week that has just passed.

getYear() - Method in class org.springframework.modulith.moments.YearHasPassed

The Year that has just passed.

getZoneId() - Method in class org.springframework.modulith.moments.support.MomentsProperties

The ZoneId to determine times which are attached to the events published.

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

H2 - Enum constant in enum class org.springframework.modulith.events.jdbc.DatabaseType

hasExplicitInterfaces() - Method in class org.springframework.modulith.core.NamedInterfaces

Returns whether at least one explicit NamedInterface is declared.

hashCode() - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependencies

hashCode() - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependency

hashCode() - Method in class org.springframework.modulith.core.ApplicationModule

hashCode() - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

hashCode() - Method in class org.springframework.modulith.core.Classes

hashCode() - Method in class org.springframework.modulith.core.EventType

hashCode() - Method in class org.springframework.modulith.core.JavaPackage

hashCode() - Method in class org.springframework.modulith.core.SpringBean

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.

hashCode() - Method in class org.springframework.modulith.events.DefaultEventPublication

hashCode() - Method in class org.springframework.modulith.events.PublicationTargetIdentifier

hashCode() - Method in class org.springframework.modulith.moments.DayHasPassed

hashCode() - Method in class org.springframework.modulith.moments.HourHasPassed

hashCode() - Method in class org.springframework.modulith.moments.MonthHasPassed

hashCode() - Method in class org.springframework.modulith.moments.QuarterHasPassed

hashCode() - Method in class org.springframework.modulith.moments.ShiftedQuarter

hashCode() - Method in class org.springframework.modulith.moments.WeekHasPassed

hashCode() - Method in class org.springframework.modulith.moments.YearHasPassed

hashCode() - Method in class org.springframework.modulith.test.ModuleContextCustomizerFactory.ModuleContextCustomizer

hashCode() - Method in class org.springframework.modulith.test.ModuleTestExecution

hashCode() - Method in class org.springframework.modulith.test.ModuleTypeExcludeFilter

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

hasSameNameAs(NamedInterface) - Method in class org.springframework.modulith.core.NamedInterface

Returns whether the given NamedInterface has the same name as the current one.

hasSources() - Method in class org.springframework.modulith.core.EventType

Whether any sources exist at all.

hasSourceType() - Method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty

hasType(DependencyType) - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

Returns whether the ApplicationModule.QualifiedDependency has the given DependencyType.

hasViolations() - Method in exception org.springframework.modulith.core.Violations

Returns whether there are violations available.

HIDDEN - Enum constant in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships

hideInternalFilter(ApplicationModule) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions

HourHasPassed - Class in org.springframework.modulith.moments

A DomainEvent published on each day.

HOURS - Enum constant in enum class org.springframework.modulith.moments.support.MomentsProperties.Granularity

Publish hourly events.

HSQLDB - Enum constant in enum class org.springframework.modulith.events.jdbc.DatabaseType

I

id - Variable in class org.springframework.modulith.events.jpa.JpaEventPublication

id - Variable in class org.springframework.modulith.events.mongodb.MongoDbEventPublication

ifPresent(Consumer<Stream<TransactionalApplicationListener<ApplicationEvent>>>) - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster.TransactionalEventListeners

Executes the given consumer only if there are actual listeners available.

IMMEDIATE - Enum constant in enum class org.springframework.modulith.core.DependencyDepth

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.

includes(String) - Method in class org.springframework.modulith.test.ModuleTestExecution

initialize() - Method in interface org.springframework.modulith.ApplicationModuleInitializer

Run business logic that's needed to initialize the ApplicationModule.

invoke(MethodInvocation) - Method in class org.springframework.modulith.events.support.CompletionRegisteringAdvisor.CompletionRegisteringMethodInterceptor

invoke(MethodInvocation) - Method in class org.springframework.modulith.observability.ModuleEntryInterceptor

isAggregateRoot() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isAggregateRoot() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Returns whether the type is considered an aggregate root in the DDD sense.

isAggregateRoot() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

isAggregateRoot() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isAggregateRoot() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringDataAwareArchitecturallyEvidentType

isAnnotatedWith(Class<?>) - Static method in class org.springframework.modulith.core.Types

isAnnotatedWith(String) - Static method in class org.springframework.modulith.core.Types

isApiBean() - Method in class org.springframework.modulith.core.SpringBean

Returns whether the bean is considered to be an API bean, which means it is either a public type exposed in an API package of the module or implements a public API interface.

isApplicationClass(Class<?>) - Method in class org.springframework.modulith.runtime.ApplicationModulesRuntime

Returns whether a given Class is considered an application one (versus Framework ones).

isApplicationClass(Class<?>) - Method in interface org.springframework.modulith.runtime.ApplicationRuntime

Returns whether the given type is an application class, i.e.

isApplicationClass(Class<?>) - Method in class org.springframework.modulith.runtime.autoconfigure.SpringBootApplicationRuntime

isAsync() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.ReferenceMethod

isAtBeanMethod(JavaMethod) - Static method in class org.springframework.modulith.core.Types.SpringTypes

isComponent() - Static method in class org.springframework.modulith.core.Types.SpringTypes

isConfiguration() - Static method in class org.springframework.modulith.core.Types.SpringTypes

isConfigurationProperties() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isConfigurationProperties() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

isConfigurationProperties() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isConfigurationProperties() - Static method in class org.springframework.modulith.core.Types.SpringTypes

isController() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isController() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

isController() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isController() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringDataAwareArchitecturallyEvidentType

isEmpty() - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependencies

Returns whether the ApplicationModule.DeclaredDependencies are empty.

isEmpty() - Method in class org.springframework.modulith.core.ApplicationModuleDependencies

Returns whether there are any dependencies at all.

isEmpty() - Method in class org.springframework.modulith.core.Classes

isEnableTimeMachine() - Method in class org.springframework.modulith.moments.support.MomentsProperties

Whether to enable the TimeMachine.

isEntity() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isEntity() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Returns whether the type is an entity in the DDD sense.

isEntity() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

isEntity() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringDataAwareArchitecturallyEvidentType

isEventListener() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isEventListener() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

isEventListener() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

isEventListener() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isExposed(JavaClass) - Method in class org.springframework.modulith.core.ApplicationModule

Returns whether the given JavaClass is exposed by the current module, i.e.

isHourly() - Method in class org.springframework.modulith.moments.support.MomentsProperties

Returns whether to create hourly events.

isIdentifiedBy(PublicationTargetIdentifier) - Method in interface org.springframework.modulith.events.EventPublication

Returns whether the publication is identified by the given PublicationTargetIdentifier.

isInjectable() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isInjectable() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

isInjectable() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isJpaEntity() - Static method in class org.springframework.modulith.core.Types.JavaXTypes

isLastDay(LocalDate) - Method in class org.springframework.modulith.moments.ShiftedQuarter

Returns whether the given LocalDate is the last day of the ShiftedQuarter.

isObservedModule(ApplicationModule) - Method in class org.springframework.modulith.observability.DefaultObservedModule

isObservedModule(ApplicationModule) - Method in interface org.springframework.modulith.observability.ObservedModule

isPackageInfoType(JavaClass) - Static method in class org.springframework.modulith.core.JavaPackage

Returns whether the given type is the package-info.java one.

isPresent() - Static method in class org.springframework.modulith.core.Types.JMoleculesTypes

isPresent() - Static method in class org.springframework.modulith.core.Types.SpringDataTypes

isPublicationCompleted() - Method in interface org.springframework.modulith.events.CompletableEventPublication

Returns whether the publication o

isRepository() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isRepository() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Returns whether the type is considered a repository in the DDD sense.

isRepository() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

isRepository() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isRepository() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringDataAwareArchitecturallyEvidentType

isService() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isService() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

isService() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

isService() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

isSpringDataRepository() - Static method in class org.springframework.modulith.core.Types.SpringDataTypes

isUnnamed() - Method in class org.springframework.modulith.core.NamedInterface

Returns whether this is the unnamed (implicit) NamedInterface.

isValidDependencyWithin(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

isValueObject() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

isValueObject() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

isValueObject() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

iterator() - Method in class org.springframework.modulith.core.ApplicationModules

iterator() - Method in class org.springframework.modulith.core.Classes

iterator() - Method in class org.springframework.modulith.core.JavaPackage

iterator() - Method in class org.springframework.modulith.core.NamedInterface

iterator() - Method in class org.springframework.modulith.core.NamedInterfaces

iterator() - Method in class org.springframework.modulith.docs.ConfigurationProperties

iterator() - Method in class org.springframework.modulith.test.ModuleTestExecution

J

JacksonEventSerializationConfiguration - Class in org.springframework.modulith.events.jackson

Application configuration to register a Jackson-based EventSerializer.

JacksonEventSerializationConfiguration(ObjectProvider<ObjectMapper>, ApplicationContext) - Constructor for class org.springframework.modulith.events.jackson.JacksonEventSerializationConfiguration

Creates a new JacksonEventSerializationConfiguration for the given ObjectMapper and ApplicationContext.

jacksonEventSerializer() - Method in class org.springframework.modulith.events.jackson.JacksonEventSerializationConfiguration

JacksonEventSerializer - Class in org.springframework.modulith.events.jackson

A Jackson-based EventSerializer.

JacksonEventSerializer(Supplier<ObjectMapper>) - Constructor for class org.springframework.modulith.events.jackson.JacksonEventSerializer

Creates a new JacksonEventSerializer for the given ObjectMapper.

JavaAccessSource - Class in org.springframework.modulith.core

A Source backed by an ArchUnit JavaAccess.

JavaAccessSource(JavaAccess<?>) - Constructor for class org.springframework.modulith.core.JavaAccessSource

Creates a new JavaAccessSource for the given JavaAccess.

JavaPackage - Class in org.springframework.modulith.core

An abstraction of a Java package.

JavaXTypes() - Constructor for class org.springframework.modulith.core.Types.JavaXTypes

JdbcEventPublicationAutoConfiguration - Class in org.springframework.modulith.events.jdbc

JdbcEventPublicationAutoConfiguration() - Constructor for class org.springframework.modulith.events.jdbc.JdbcEventPublicationAutoConfiguration

jdbcEventPublicationRepository(JdbcTemplate, EventSerializer, DatabaseType) - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationAutoConfiguration

JdbcEventPublicationRepository - Class in org.springframework.modulith.events.jdbc

JDBC-based repository to store EventPublications.

JdbcEventPublicationRepository(JdbcOperations, EventSerializer, DatabaseType) - Constructor for class org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

Creates a new JdbcEventPublicationRepository for the given JdbcOperations, EventSerializer and DatabaseType.

JMoleculesArchitecturallyEvidentType(JavaClass) - Constructor for class org.springframework.modulith.core.ArchitecturallyEvidentType.JMoleculesArchitecturallyEvidentType

JMoleculesModule(JavaPackage) - Constructor for class org.springframework.modulith.core.ApplicationModuleInformation.JMoleculesModule

JMoleculesTypes() - Constructor for class org.springframework.modulith.core.Types.JMoleculesTypes

JpaEventPublication - Class in org.springframework.modulith.events.jpa

JPA entity to represent event publications.

JpaEventPublication() - Constructor for class org.springframework.modulith.events.jpa.JpaEventPublication

JpaEventPublication(Instant, String, String, Class<?>) - Constructor for class org.springframework.modulith.events.jpa.JpaEventPublication

Creates a new JpaEventPublication for the given publication date, listener id, serialized event and event type.

JpaEventPublicationAutoConfiguration - Class in org.springframework.modulith.events.jpa

Auto-configuration for JPA based event publication.

JpaEventPublicationAutoConfiguration() - Constructor for class org.springframework.modulith.events.jpa.JpaEventPublicationAutoConfiguration

JpaEventPublicationConfiguration - Class in org.springframework.modulith.events.jpa

JpaEventPublicationConfiguration() - Constructor for class org.springframework.modulith.events.jpa.JpaEventPublicationConfiguration

jpaEventPublicationRepository(EntityManager, EventSerializer) - Method in class org.springframework.modulith.events.jpa.JpaEventPublicationConfiguration

JpaEventPublicationRepository - Class in org.springframework.modulith.events.jpa

Repository to store EventPublications.

JpaEventPublicationRepository(EntityManager, EventSerializer) - Constructor for class org.springframework.modulith.events.jpa.JpaEventPublicationRepository

Creates a new JpaEventPublicationRepository for the given EntityManager and EventSerializer.

Json - Class in org.springframework.modulith.core.util

Helper to render a Map as JSON.

Json() - Constructor for class org.springframework.modulith.core.util.Json

K

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

L

listenerId - Variable in class org.springframework.modulith.events.jpa.JpaEventPublication

listenerId - Variable in class org.springframework.modulith.events.mongodb.MongoDbEventPublication

loadIfPresent(String) - Static method in class org.springframework.modulith.core.Types

M

main(String[]) - Static method in class org.springframework.modulith.core.util.ApplicationModulesExporter

Simple main method to render the ApplicationModules instance defined for the Java package given as first argument.

markCompleted() - Method in interface org.springframework.modulith.events.CompletableEventPublication

Marks the event publication as completed.

markCompleted() - Method in class org.springframework.modulith.events.DefaultEventPublication

markCompleted() - Method in class org.springframework.modulith.events.jpa.JpaEventPublication

markCompleted(Object, PublicationTargetIdentifier) - Method in class org.springframework.modulith.events.DefaultEventPublicationRegistry

markCompleted(Object, PublicationTargetIdentifier) - Method in interface org.springframework.modulith.events.EventPublicationRegistry

Marks the publication for the given event and PublicationTargetIdentifier as completed.

markCompleted(Instant) - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublication

Marks the publication as completed at the given Instant.

match(MetadataReader, MetadataReaderFactory) - Method in class org.springframework.modulith.test.ModuleTypeExcludeFilter

matches(SpringBean) - Method in class org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping

Returns whether the given SpringBean matches the Documenter.CanvasOptions.Grouping.

matching(Function<T, S>, Predicate<? super S>) - Method in interface org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents

Returns all PublishedEvents.TypedPublishedEvents that match the given predicate after applying the given mapping step.

matching(Function<T, S>, Predicate<? super S>) - Method in class org.springframework.modulith.test.PublishedEventsAssert.PublishedEventAssert

Asserts that at least one event exists for which the value extracted by the given Function matches the given Predicate.

matching(Function<T, S>, S) - Method in interface org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents

Returns all PublishedEvents.TypedPublishedEvents that match the given value after applying the given mapping step.

matching(Function<T, S>, S) - Method in class org.springframework.modulith.test.PublishedEventsAssert.PublishedEventAssert

Asserts that at least one event exists for which the value extracted by the given Function matches the given one.

matching(Predicate<? super E>) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Matches events that satisfy the given Predicate.

matching(Predicate<? super T>) - Method in interface org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents

Returns all PublishedEvents.TypedPublishedEvents that match the given predicate.

matching(Predicate<? super T>) - Method in class org.springframework.modulith.test.PublishedEventsAssert.PublishedEventAssert

Asserts that at least one event matches the given predicate.

matchingMapped(Function<E, S>, Predicate<? super S>) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Matches events that satisfy the given Predicate after extracting a value using the given Function.

matchingMapped(Function<T, S>, Predicate<? super S>) - Method in interface org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents

Deprecated, for removal: This API element is subject to removal in a future version.

since 0.3, use PublishedEvents.TypedPublishedEvents.matching(Function, Predicate) instead.

matchingMappedValue(Function<E, S>, S) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Matches events that extracting the given value using the given Function.

merge(NamedInterface.TypeBasedNamedInterface) - Method in class org.springframework.modulith.core.NamedInterface

Merges the current NamedInterface with the given NamedInterface.TypeBasedNamedInterface.

merge(NamedInterface.TypeBasedNamedInterface) - Method in class org.springframework.modulith.core.NamedInterface.TypeBasedNamedInterface

MissingRuntimeDependency - Exception in org.springframework.modulith.runtime.autoconfigure

An Exception carrying information about a missing runtime dependency to be analyzed by MissingRuntimeDependencyFailureAnalyzer.

MissingRuntimeDependency(String, String) - Constructor for exception org.springframework.modulith.runtime.autoconfigure.MissingRuntimeDependency

MissingRuntimeDependencyFailureAnalyzer - Class in org.springframework.modulith.runtime.autoconfigure

FailureAnalyzer for MissingRuntimeDependency.

MissingRuntimeDependencyFailureAnalyzer() - Constructor for class org.springframework.modulith.runtime.autoconfigure.MissingRuntimeDependencyFailureAnalyzer

mode() - Element in annotation interface org.springframework.modulith.test.ApplicationModuleTest

MODULE_BAGGAGE_KEY - Static variable in class org.springframework.modulith.observability.ModuleTracingBeanPostProcessor

moduleBaggagePropagationCustomizer() - Method in class org.springframework.modulith.observability.autoconfigure.ModuleObservabilityAutoConfiguration.ModulithsBraveIntegrationAutoConfiguration

ModuleContextCustomizerFactory - Class in org.springframework.modulith.test

ModuleContextCustomizerFactory() - Constructor for class org.springframework.modulith.test.ModuleContextCustomizerFactory

ModuleContextCustomizerFactory.ModuleContextCustomizer - Class in org.springframework.modulith.test

ModuleEntryInterceptor - Class in org.springframework.modulith.observability

ModuleEventListener - Class in org.springframework.modulith.observability

ModuleEventListener(ApplicationModulesRuntime, Supplier<Tracer>) - Constructor for class org.springframework.modulith.observability.ModuleEventListener

Creates a new ModuleEventListener for the given ApplicationModulesRuntime and Tracer.

ModuleObservabilityAutoConfiguration - Class in org.springframework.modulith.observability.autoconfigure

ModuleObservabilityAutoConfiguration() - Constructor for class org.springframework.modulith.observability.autoconfigure.ModuleObservabilityAutoConfiguration

ModuleObservabilityAutoConfiguration.ModulithsBraveIntegrationAutoConfiguration - Class in org.springframework.modulith.observability.autoconfigure

Brave-specific auto configuration.

ModuleProperty(String, String, String, JavaType, String) - Constructor for record class org.springframework.modulith.docs.ConfigurationProperties.ModuleProperty

Creates an instance of a ModuleProperty record class.

modulesRuntime(ApplicationRuntime) - Method in class org.springframework.modulith.runtime.autoconfigure.SpringModulithRuntimeAutoConfiguration

ModuleTestAutoConfiguration - Class in org.springframework.modulith.test

An unconditional auto-configuration registering an ImportBeanDefinitionRegistrar to customize both the entity scan and auto-configuration packages to the packages defined by the ModuleTestExecution in the application context.

ModuleTestAutoConfiguration() - Constructor for class org.springframework.modulith.test.ModuleTestAutoConfiguration

ModuleTestAutoConfiguration.AutoConfigurationAndEntityScanPackageCustomizer - Class in org.springframework.modulith.test

ModuleTestExecution - Class in org.springframework.modulith.test

moduleTracingBeanPostProcessor(ApplicationModulesRuntime, ObjectProvider<Tracer>) - Static method in class org.springframework.modulith.observability.autoconfigure.ModuleObservabilityAutoConfiguration

ModuleTracingBeanPostProcessor - Class in org.springframework.modulith.observability

A BeanPostProcessor that decorates beans exposed by application modules with an interceptor that registers module entry and exit to create tracing spans for those invocations.

ModuleTracingBeanPostProcessor(ApplicationModulesRuntime, Supplier<Tracer>) - Constructor for class org.springframework.modulith.observability.ModuleTracingBeanPostProcessor

Creates a new ModuleTracingBeanPostProcessor for the given ApplicationModulesRuntime and Tracer.

ModuleTracingSupport - Class in org.springframework.modulith.observability

ModuleTracingSupport() - Constructor for class org.springframework.modulith.observability.ModuleTracingSupport

ModuleTypeExcludeFilter - Class in org.springframework.modulith.test

ModuleTypeExcludeFilter(Class<?>) - Constructor for class org.springframework.modulith.test.ModuleTypeExcludeFilter

Modulith - Annotation Interface in org.springframework.modulith

Defines a Spring Boot application to follow the Modulith structuring conventions.

Modulithic - Annotation Interface in org.springframework.modulith

Defines a Spring Boot application to follow the Modulith structuring conventions.

ModulithMetadata - Interface in org.springframework.modulith.core

modulithsApplicationRuntime(ApplicationContext) - Method in class org.springframework.modulith.runtime.autoconfigure.SpringModulithRuntimeAutoConfiguration

ModulithsBraveIntegrationAutoConfiguration() - Constructor for class org.springframework.modulith.observability.autoconfigure.ModuleObservabilityAutoConfiguration.ModulithsBraveIntegrationAutoConfiguration

moments(ObjectProvider<Clock>, ApplicationEventPublisher, MomentsProperties) - Method in class org.springframework.modulith.moments.autoconfigure.MomentsAutoConfiguration

Moments - Class in org.springframework.modulith.moments.support

Core component to publish passage-of-time events.

Moments(Clock, ApplicationEventPublisher, MomentsProperties) - Constructor for class org.springframework.modulith.moments.support.Moments

Creates a new Moments for the given Clock, ApplicationEventPublisher and MomentsProperties.

MomentsAutoConfiguration - Class in org.springframework.modulith.moments.autoconfigure

Auto-configuration for Moments.

MomentsAutoConfiguration() - Constructor for class org.springframework.modulith.moments.autoconfigure.MomentsAutoConfiguration

MomentsProperties - Class in org.springframework.modulith.moments.support

Configuration properties for Moments.

MomentsProperties.Granularity - Enum Class in org.springframework.modulith.moments.support

The granularity of events to publish.

MongoDbEventPublication - Class in org.springframework.modulith.events.mongodb

A MongoDB Document to represent event publications.

MongoDbEventPublication(Instant, String, Object) - Constructor for class org.springframework.modulith.events.mongodb.MongoDbEventPublication

Creates a new MongoDbEventPublication for the given publication date, listener id and event.

MongoDbEventPublication(ObjectId, Instant, String, Object, Instant) - Constructor for class org.springframework.modulith.events.mongodb.MongoDbEventPublication

Creates a new MongoDbEventPublication for the given id, publication date, listener id, event and completion date.

MongoDbEventPublicationAutoConfiguration - Class in org.springframework.modulith.events.mongodb

Autoconfiguration for MongoDB event publication repository.

MongoDbEventPublicationAutoConfiguration() - Constructor for class org.springframework.modulith.events.mongodb.MongoDbEventPublicationAutoConfiguration

mongoDbEventPublicationRepository(MongoTemplate) - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublicationAutoConfiguration

MongoDbEventPublicationRepository - Class in org.springframework.modulith.events.mongodb

Repository to store EventPublications in a MongoDB.

MongoDbEventPublicationRepository(MongoTemplate) - Constructor for class org.springframework.modulith.events.mongodb.MongoDbEventPublicationRepository

Creates a new MongoDbEventPublicationRepository for the given MongoTemplate.

MonthHasPassed - Class in org.springframework.modulith.moments

A DomainEvent published on the last day of the month.

multicastEvent(ApplicationEvent) - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster

multicastEvent(ApplicationEvent, ResolvableType) - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster

MYSQL - Enum constant in enum class org.springframework.modulith.events.jdbc.DatabaseType

N

name - Variable in class org.springframework.modulith.core.NamedInterface

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.

name() - Element in annotation interface org.springframework.modulith.NamedInterface

The name(s) of the named interface.

NamedInterface - Class in org.springframework.modulith.core

A named interface into an ApplicationModule.

NamedInterface - Annotation Interface in org.springframework.modulith

Annotation to mark a package as named interface of a ApplicationModule (either implicit or explicitly annotated).

NamedInterface(String) - Constructor for class org.springframework.modulith.core.NamedInterface

Creates a new NamedInterface with the given name.

NamedInterface.TypeBasedNamedInterface - Class in org.springframework.modulith.core

NamedInterfaces - Class in org.springframework.modulith.core

A collection of NamedInterfaces.

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.

next() - Method in enum class org.springframework.modulith.moments.Quarter

Returns the next logical Quarter.

next() - Method in class org.springframework.modulith.moments.ShiftedQuarter

Returns the next ShiftedQuarter.

NONE - Enum constant in enum class org.springframework.modulith.core.DependencyDepth

NONE - Static variable in class org.springframework.modulith.core.Classes

NONE - Static variable in class org.springframework.modulith.core.NamedInterfaces

NONE - Static variable in exception org.springframework.modulith.core.Violations

now() - Method in class org.springframework.modulith.moments.support.Moments

now() - Method in class org.springframework.modulith.moments.support.TimeMachine

O

ObservedModule - Interface in org.springframework.modulith.observability

ObservedModuleType - Class in org.springframework.modulith.observability

Represents a type in an ObservedModule.

ObservedModuleType(ApplicationModules, ObservedModule, ArchitecturallyEvidentType) - Constructor for class org.springframework.modulith.observability.ObservedModuleType

Creates a new ObservedModuleType for the given ApplicationModules, ObservedModule and ArchitecturallyEvidentType.

of(int) - Static method in class org.springframework.modulith.moments.YearHasPassed

Creates a new YearHasPassed event for the given year.

of(JavaClass) - Static method in class org.springframework.modulith.core.FormatableType

Creates a new FormatableType for the given JavaClass.

of(JavaClasses) - Static method in class org.springframework.modulith.core.Classes

Creates a new Classes for the given JavaClasses.

of(JavaClass, List<ArchitecturallyEvidentType>) - Static method in class org.springframework.modulith.core.ArchitecturallyEvidentType.DelegatingType

of(JavaClass, ApplicationModule) - Static method in class org.springframework.modulith.core.SpringBean

Creates a new SpringBean for the given JavaClass and ApplicationModule.

of(JavaClass, Classes) - Static method in class org.springframework.modulith.core.ArchitecturallyEvidentType

Creates a new ArchitecturallyEvidentType for the given JavaType and Classes of Spring components.

of(Class<?>) - Static method in class org.springframework.modulith.core.AnnotationModulithMetadata

Creates a ModulithMetadata inspecting Modulithic annotation or return Optional.empty() if the type given does not carry the annotation.

of(Class<?>) - Static method in class org.springframework.modulith.core.ApplicationModules

Creates a new ApplicationModules relative to the given modulith type.

of(Class<?>) - Static method in class org.springframework.modulith.core.FormatableType

Creates a new FormatableType for the given Class.

of(Class<?>) - Static method in interface org.springframework.modulith.core.ModulithMetadata

Creates a new ModulithMetadata for the given annotated type.

of(Class<?>) - Static method in class org.springframework.modulith.core.SpringBootModulithMetadata

Creates a new ModulithMetadata representing the defaults of a class annotated with SpringBootApplication but not customized with Modulithic or Modulith.

of(Class<?>) - Static method in class org.springframework.modulith.test.ModuleTestExecution

of(Class<?>, DescribedPredicate<JavaClass>) - Static method in class org.springframework.modulith.core.ApplicationModules

Creates a new ApplicationModules relative to the given modulith type, a ApplicationModuleDetectionStrategy and a DescribedPredicate which types and packages to ignore.

of(Object...) - Static method in interface org.springframework.modulith.test.PublishedEvents

Creates a new PublishedEvents instance for the given events.

of(Object, PublicationTargetIdentifier) - Static method in interface org.springframework.modulith.events.CompletableEventPublication

Creates a CompletableEventPublication for the given event an listener identifier.

of(String) - Static method in class org.springframework.modulith.core.ApplicationModules

Creates a new ApplicationModules instance for the given package name.

of(String) - Static method in interface org.springframework.modulith.core.ModulithMetadata

Creates a new ModulithMetadata instance for the given package.

of(String) - Static method in class org.springframework.modulith.core.SpringBootModulithMetadata

Creates a new ModulithMetadata from the given package name.

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) - Static method in class org.springframework.modulith.events.PublicationTargetIdentifier

Returns the PublicationTargetIdentifier for the given value.

of(String) - Static method in class org.springframework.modulith.test.TestApplicationModules

Creates an ApplicationModules instance from the given package but only inspecting the test code.

of(String, DescribedPredicate<JavaClass>) - Static method in class org.springframework.modulith.core.ApplicationModules

Creates a new ApplicationModules instance for the given package name and ignored classes.

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(String, ApplicationModule, ApplicationModules) - Static method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependency

Creates an ApplicationModule.DeclaredDependency to the module and optionally named interface defined by the given identifier.

of(String, Classes, JavaPackage) - Static method in class org.springframework.modulith.core.NamedInterface

Returns a NamedInterface.TypeBasedNamedInterface with the given name, Classes and base JavaPackage.

of(LocalDate) - Static method in class org.springframework.modulith.moments.DayHasPassed

Creates a new DayHasPassed for the given LocalDate.

of(LocalDateTime) - Static method in class org.springframework.modulith.moments.HourHasPassed

Creates a new HourHasPassed for the given LocalDateTime.

of(Year) - Static method in class org.springframework.modulith.moments.YearHasPassed

Creates a new YearHasPassed for the given Year.

of(YearMonth) - Static method in class org.springframework.modulith.moments.MonthHasPassed

Creates a new MonthHasPassed for the given YearMonth.

of(Year, int) - Static method in class org.springframework.modulith.moments.WeekHasPassed

Creates a new WeekHasPassed for the given Year and week of the year.

of(Year, int, Locale) - Static method in class org.springframework.modulith.moments.WeekHasPassed

Creates a new WeekHasPassed for the given Year, week and Locale.

of(Year, Quarter) - Static method in class org.springframework.modulith.moments.QuarterHasPassed

Returns a QuarterHasPassed for the given Year and logical Quarter.

of(Year, Quarter, Month) - Static method in class org.springframework.modulith.moments.QuarterHasPassed

Returns a QuarterHasPassed for the given Year, logical Quarter and start Month.

of(Year, ShiftedQuarter) - Static method in class org.springframework.modulith.moments.QuarterHasPassed

Returns a QuarterHasPassed for the given Year and ShiftedQuarter.

of(Collection<? extends Object>) - Static method in interface org.springframework.modulith.test.PublishedEvents

Creates a new PublishedEvents instance for the given events.

of(List<JavaClass>) - Static method in class org.springframework.modulith.core.Classes

Creates a new Classes for the given JavaClasses.

of(List<ApplicationModuleDependency>, ApplicationModules) - Static method in class org.springframework.modulith.core.ApplicationModuleDependencies

Creates a new ApplicationModuleDependencies for the given List of ApplicationModuleDependency and ApplicationModules.

of(List<NamedInterface>) - Static method in class org.springframework.modulith.core.NamedInterfaces

Creates a new NamedInterfaces for the given NamedInterfaces.

of(Map<String, Object>) - Static method in record class org.springframework.modulith.docs.ConfigurationProperties.ConfigurationProperty

of(Classes, String) - Static method in class org.springframework.modulith.core.JavaPackage

Creates a new JavaPackage for the given classes and name.

of(JavaPackage) - Static method in interface org.springframework.modulith.core.ApplicationModuleInformation

Creates a new ApplicationModuleInformation for the given JavaPackage.

of(JavaPackage) - Static method in class org.springframework.modulith.core.NamedInterface

Returns all NamedInterface.PackageBasedNamedInterfaces for the given JavaPackage.

of(Quarter) - Static method in class org.springframework.modulith.moments.ShiftedQuarter

of(Quarter, Month) - Static method in class org.springframework.modulith.moments.ShiftedQuarter

Creates a new ShiftedQuarter for the given Quarter and start Month.

of(ObservedModule, Tracer) - Static method in class org.springframework.modulith.observability.ModuleEntryInterceptor

ofAnnotatedPackages(JavaPackage) - Static method in class org.springframework.modulith.core.NamedInterfaces

Creates a new NamedInterfaces for the given base JavaPackage.

ofSubType(Class<S>) - Method in interface org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents

Further constrain the event type for downstream assertions.

ofType(Class<S>) - Method in interface org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents

ofType(Class<T>) - Method in class org.springframework.modulith.test.DefaultAssertablePublishedEvents

ofType(Class<T>) - Method in class org.springframework.modulith.test.DefaultPublishedEvents

ofType(Class<T>) - Method in interface org.springframework.modulith.test.PublishedEvents

ofType(Class<T>) - Method in interface org.springframework.modulith.test.TypedEvents

Returns all events of the given type.

onApplicationEvent(ApplicationEvent) - Method in class org.springframework.modulith.observability.ModuleEventListener

onApplicationEvent(ApplicationEvent) - Method in class org.springframework.modulith.test.DefaultAssertablePublishedEvents

onApplicationEvent(ApplicationEvent) - Method in class org.springframework.modulith.test.DefaultPublishedEvents

org.springframework.modulith - package org.springframework.modulith

Core abstractions of Spring Modulith.

org.springframework.modulith.actuator - package org.springframework.modulith.actuator

Spring Boot actuator support for Spring Modulith.

org.springframework.modulith.actuator.autoconfigure - package org.springframework.modulith.actuator.autoconfigure

Autoconfiguration for Spring Modulith actuators.

org.springframework.modulith.core - package org.springframework.modulith.core

Core, internal abstractions of Spring Modulith.

org.springframework.modulith.core.util - package org.springframework.modulith.core.util

Utilities.

org.springframework.modulith.docs - package org.springframework.modulith.docs

Documentation support for Spring Modulith.

org.springframework.modulith.events - package org.springframework.modulith.events

The event publication registry abstraction.

org.springframework.modulith.events.config - package org.springframework.modulith.events.config

Spring configuration for the event publication registry.

org.springframework.modulith.events.jackson - package org.springframework.modulith.events.jackson

A Jackson based implementation of the EventSerializer.

org.springframework.modulith.events.jdbc - package org.springframework.modulith.events.jdbc

JDBC integration for EventPublicationRepository.

org.springframework.modulith.events.jpa - package org.springframework.modulith.events.jpa

JPA integration for EventPublicationRepository.

org.springframework.modulith.events.mongodb - package org.springframework.modulith.events.mongodb

MongoDB integration for EventPublicationRepository.

org.springframework.modulith.events.support - package org.springframework.modulith.events.support

Spring Framework extensions to integrate the event publication registry.

org.springframework.modulith.moments - package org.springframework.modulith.moments

An Passage-of-Time events implementation.

org.springframework.modulith.moments.autoconfigure - package org.springframework.modulith.moments.autoconfigure

Autoconfiguration for the Moments API.

org.springframework.modulith.moments.support - package org.springframework.modulith.moments.support

The Moments abstraction to integrate with Spring Framework's scheduling.

org.springframework.modulith.observability - package org.springframework.modulith.observability

Support for application module observability.

org.springframework.modulith.observability.autoconfigure - package org.springframework.modulith.observability.autoconfigure

Autoconfiguration for the observability integration.

org.springframework.modulith.runtime - package org.springframework.modulith.runtime

Support to run ApplicationModules at application runtime.

org.springframework.modulith.runtime.autoconfigure - package org.springframework.modulith.runtime.autoconfigure

Autoconfiguration the ApplicationModules runtime support.

org.springframework.modulith.test - package org.springframework.modulith.test

Integration test support for Spring Modulith ApplicationModules.

P

PersistentApplicationEventMulticaster - Class in org.springframework.modulith.events.support

An ApplicationEventMulticaster to register EventPublications in an EventPublicationRegistry so that potentially failing transactional event listeners can get re-invoked upon application restart or via a schedule.

PersistentApplicationEventMulticaster(Supplier<EventPublicationRegistry>) - Constructor for class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster

Creates a new PersistentApplicationEventMulticaster for the given EventPublicationRegistry.

PersistentApplicationEventMulticaster.TransactionalEventListeners - Class in org.springframework.modulith.events.support

First-class collection to work with transactional event listeners, i.e.

PersistentDomainEventsImportSelector(ResourceLoader) - Constructor for class org.springframework.modulith.events.config.EnablePersistentDomainEvents.PersistentDomainEventsImportSelector

POSTGRES - Enum constant in enum class org.springframework.modulith.events.jdbc.DatabaseType

postProcessAfterInitialization(Object, String) - Method in class org.springframework.modulith.events.config.EventPublicationConfiguration.AsyncPropertiesDefaulter

postProcessAfterInitialization(Object, String) - Method in class org.springframework.modulith.observability.ModuleTracingBeanPostProcessor

postProcessAfterInitialization(Object, String) - Method in class org.springframework.modulith.observability.SpringDataRestModuleTracingBeanPostProcessor

publicationDate - Variable in class org.springframework.modulith.events.jpa.JpaEventPublication

publicationDate - Variable in class org.springframework.modulith.events.mongodb.MongoDbEventPublication

PublicationTargetIdentifier - Class in org.springframework.modulith.events

Identifier for a publication target.

publish(Object) - Method in class org.springframework.modulith.test.Scenario

Publishes the given event.

publish(Supplier<Object>) - Method in class org.springframework.modulith.test.Scenario

Publishes the event provided by the given Supplier.

PublishedEvents - Interface in org.springframework.modulith.test

All Spring application events fired during the test execution.

PublishedEvents.TypedPublishedEvents<T> - Interface in org.springframework.modulith.test

All application events of a given type that were fired during a test execution.

PublishedEventsAssert - Class in org.springframework.modulith.test

AssertJ Assert for PublishedEvents.

PublishedEventsAssert(TypedEvents) - Constructor for class org.springframework.modulith.test.PublishedEventsAssert

Creates a new PublishedEventsAssert

PublishedEventsAssert.PublishedEventAssert<T> - Class in org.springframework.modulith.test

Assertions further qualifying the expected events.

PublishedEventsExtension - Class in org.springframework.modulith.test

JUnit 5 Extension for standalone usage without ApplicationModuleTest.

PublishedEventsExtension() - Constructor for class org.springframework.modulith.test.PublishedEventsExtension

PublishedEventsParameterResolver - Class in org.springframework.modulith.test

Provides instances of PublishedEvents as test method parameters.

PublishedEventsParameterResolver() - Constructor for class org.springframework.modulith.test.PublishedEventsParameterResolver

PublishedEventsParameterResolver(Function<ExtensionContext, ApplicationContext>) - Constructor for class org.springframework.modulith.test.PublishedEventsParameterResolver

Q

Q1 - Enum constant in enum class org.springframework.modulith.moments.Quarter

Q2 - Enum constant in enum class org.springframework.modulith.moments.Quarter

Q3 - Enum constant in enum class org.springframework.modulith.moments.Quarter

Q4 - Enum constant in enum class org.springframework.modulith.moments.Quarter

QualifiedDependency(Dependency) - Constructor for class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

QualifiedDependency(JavaClass, JavaClass, String, DependencyType) - Constructor for class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

Creates a new ApplicationModule.QualifiedDependency from the given source and target JavaClass, description and DependencyType.

Quarter - Enum Class in org.springframework.modulith.moments

A logical Quarter of the year.

QuarterHasPassed - Class in org.springframework.modulith.moments

A DomainEvent published once a quarter has passed.

R

readOnlyTransaction() - Element in annotation interface org.springframework.modulith.ApplicationModuleListener

Whether the transaction to be run for the event listener is supposed to be read-only (default false).

ReferenceMethod(JavaMethod) - Constructor for class org.springframework.modulith.core.ArchitecturallyEvidentType.ReferenceMethod

registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry) - Method in class org.springframework.modulith.test.ModuleTestAutoConfiguration.AutoConfigurationAndEntityScanPackageCustomizer

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

REPOSITORY - Static variable in class org.springframework.modulith.core.Types.SpringDataTypes

resolveParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.modulith.test.PublishedEventsParameterResolver

resolveParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.modulith.test.ScenarioParameterResolver

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

Scenario - Class in org.springframework.modulith.test

A DSL to define integration testing scenarios for application modules.

Scenario(TransactionTemplate, ApplicationEventPublisher, AssertablePublishedEvents) - Constructor for class org.springframework.modulith.test.Scenario

Creates a new Scenario for the given TransactionTemplate, ApplicationEventPublisher and AssertablePublishedEvents.

Scenario.When<T> - Class in org.springframework.modulith.test

Scenario.When.EventResult<E> - Class in org.springframework.modulith.test

Scenario.When.StateChangeResult<S> - Class in org.springframework.modulith.test

ScenarioParameterResolver - Class in org.springframework.modulith.test

JUnit ParameterResolver for Scenario.

ScenarioParameterResolver() - Constructor for class org.springframework.modulith.test.ScenarioParameterResolver

Creates a new ScenarioParameterResolver.

selectImports(AnnotationMetadata) - Method in class org.springframework.modulith.events.config.EnablePersistentDomainEvents.PersistentDomainEventsImportSelector

serialize(Object) - Method in interface org.springframework.modulith.events.EventSerializer

Serializes the given event into a storable format.

serialize(Object) - Method in class org.springframework.modulith.events.jackson.JacksonEventSerializer

serializedEvent - Variable in class org.springframework.modulith.events.jpa.JpaEventPublication

setBeanClassLoader(ClassLoader) - Method in class org.springframework.modulith.observability.ModuleTracingSupport

setResourceLoader(ResourceLoader) - Method in class org.springframework.modulith.events.config.EnablePersistentDomainEvents.PersistentDomainEventsImportSelector

sharedModules() - Element in annotation interface org.springframework.modulith.Modulith

The names of modules considered to be shared, i.e.

sharedModules() - Element in annotation interface org.springframework.modulith.Modulithic

The names of modules considered to be shared, i.e.

shiftBy(Duration) - Method in class org.springframework.modulith.moments.support.Moments

shiftBy(Duration) - Method in class org.springframework.modulith.moments.support.TimeMachine

ShiftedQuarter - Class in org.springframework.modulith.moments

A quarter that can be shifted to start at a configurable Month.

shouldBeTraced() - Method in class org.springframework.modulith.observability.ObservedModuleType

Returns whether the type should be traced at all.

Source - Interface in org.springframework.modulith.core

A Source of some type, bean definition etc.

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.

spanHandler() - Method in class org.springframework.modulith.observability.autoconfigure.ModuleObservabilityAutoConfiguration.ModulithsBraveIntegrationAutoConfiguration

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

SpringAwareArchitecturallyEvidentType(JavaClass, Classes) - Constructor for class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringAwareArchitecturallyEvidentType

SpringBean - Class in org.springframework.modulith.core

A Spring bean type.

SpringBootApplicationRuntime - Class in org.springframework.modulith.runtime.autoconfigure

ApplicationRuntime implementation based on an ApplicationContext and a class that's annotated with SpringBootApplication.

SpringBootApplicationRuntime(ApplicationContext) - Constructor for class org.springframework.modulith.runtime.autoconfigure.SpringBootApplicationRuntime

Creates a new SpringBootApplicationRuntime for the given ApplicationContext.

SpringBootModulithMetadata - Class in org.springframework.modulith.core

Creates a new ModulithMetadata representing the defaults of Modulithic but without the annotation present.

SpringDataAwareArchitecturallyEvidentType(JavaClass, Classes) - Constructor for class org.springframework.modulith.core.ArchitecturallyEvidentType.SpringDataAwareArchitecturallyEvidentType

SpringDataRestModuleObservabilityAutoConfiguration - Class in org.springframework.modulith.observability.autoconfigure

SpringDataRestModuleObservabilityAutoConfiguration() - Constructor for class org.springframework.modulith.observability.autoconfigure.SpringDataRestModuleObservabilityAutoConfiguration

springDataRestModuleTracingBeanPostProcessor(ApplicationModulesRuntime, ObjectProvider<Tracer>) - Static method in class org.springframework.modulith.observability.autoconfigure.SpringDataRestModuleObservabilityAutoConfiguration

SpringDataRestModuleTracingBeanPostProcessor - Class in org.springframework.modulith.observability

SpringDataRestModuleTracingBeanPostProcessor(ApplicationModulesRuntime, Supplier<Tracer>) - Constructor for class org.springframework.modulith.observability.SpringDataRestModuleTracingBeanPostProcessor

Creates a new SpringDataRestModuleTracingBeanPostProcessor for the given ApplicationModulesRuntime and Tracer.

SpringDataTypes() - Constructor for class org.springframework.modulith.core.Types.SpringDataTypes

SpringModulithModule(JavaPackage) - Constructor for class org.springframework.modulith.core.ApplicationModuleInformation.SpringModulithModule

Creates a new ApplicationModuleInformation.SpringModulithModule for the given JavaPackage.

SpringModulithRuntimeAutoConfiguration - Class in org.springframework.modulith.runtime.autoconfigure

Auto-configuration to register a SpringBootApplicationRuntime and ApplicationModulesRuntime as Spring Bean.

SpringModulithRuntimeAutoConfiguration() - Constructor for class org.springframework.modulith.runtime.autoconfigure.SpringModulithRuntimeAutoConfiguration

SpringModulithRuntimeAutoConfiguration.ArchUnitRuntimeDependencyMissingConfiguration - Class in org.springframework.modulith.runtime.autoconfigure

Auto-configuration to react to ArchUnit missing on the runtime classpath.

SpringTypes() - Constructor for class org.springframework.modulith.core.Types.SpringTypes

STANDALONE - Enum constant in enum class org.springframework.modulith.test.ApplicationModuleTest.BootstrapMode

Bootstraps the current module only.

startOrEndTable() - Static method in class org.springframework.modulith.docs.Asciidoctor

startTable(String) - Static method in class org.springframework.modulith.docs.Asciidoctor

StateChangeResult(Scenario.When.ExecutionResult<S, T>) - Constructor for class org.springframework.modulith.test.Scenario.When.StateChangeResult

stimulate(Runnable) - Method in class org.springframework.modulith.test.Scenario

Stimulates the system by executing the given Runnable.

stimulate(BiConsumer<TransactionOperations, ApplicationEventPublisher>) - Method in class org.springframework.modulith.test.Scenario

Stimulate the system using the given TransactionOperations and ApplicationEventPublisher.

stimulate(BiFunction<TransactionOperations, ApplicationEventPublisher, S>) - Method in class org.springframework.modulith.test.Scenario

Stimulate the system using the given TransactionOperations and ApplicationEventPublisher and produce a result.

stimulate(Function<TransactionOperations, S>) - Method in class org.springframework.modulith.test.Scenario

Stimulates the system using the given function providing access to the TransactionOperations and keeping the supplied value around for later verification.

stimulate(Supplier<S>) - Method in class org.springframework.modulith.test.Scenario

Stimulates the system using the given Supplier and keeping the supplied value around for later verification.

store(Object, Stream<PublicationTargetIdentifier>) - Method in class org.springframework.modulith.events.DefaultEventPublicationRegistry

store(Object, Stream<PublicationTargetIdentifier>) - Method in interface org.springframework.modulith.events.EventPublicationRegistry

Stores EventPublications for the given event and ApplicationListeners.

stream() - Method in class org.springframework.modulith.core.ApplicationModuleDependencies

Returns all ApplicationModuleDependency instances as Stream.

stream() - Method in class org.springframework.modulith.core.ApplicationModules

Returns all ApplicationModules.

stream() - Method in class org.springframework.modulith.core.Classes

stream() - Method in class org.springframework.modulith.core.JavaPackage

Returns a Stream of all JavaClasses contained in the JavaPackage.

stream() - Method in class org.springframework.modulith.core.NamedInterfaces

Create a Stream of NamedInterfaces.

stream() - Method in class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster.TransactionalEventListeners

Returns all transactional event listeners.

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.

supports(JavaPackage) - Static method in class org.springframework.modulith.core.ApplicationModuleInformation.JMoleculesModule

supports(JavaPackage) - Static method in class org.springframework.modulith.core.ApplicationModuleInformation.SpringModulithModule

Whether the given JavaPackage supports this ApplicationModuleInformation.

supportsParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.modulith.test.PublishedEventsParameterResolver

supportsParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.modulith.test.ScenarioParameterResolver

systemName() - Element in annotation interface org.springframework.modulith.Modulith

A logical system name for documentation purposes.

systemName() - Element in annotation interface org.springframework.modulith.Modulithic

A logical system name for documentation purposes.

T

TestApplicationModules - Class in org.springframework.modulith.test

Utility methods to work with test ApplicationModules.

TestApplicationModules() - Constructor for class org.springframework.modulith.test.TestApplicationModules

that(DescribedPredicate<? super JavaClass>) - Method in class org.springframework.modulith.core.Classes

Returns Classes that match the given DescribedPredicate.

that(DescribedPredicate<? super JavaClass>) - Method in class org.springframework.modulith.core.JavaPackage

Returns all Classes that match the given DescribedPredicate.

throwIfPresent() - Method in exception org.springframework.modulith.core.Violations

Throws itself in case it's not an empty instance.

timeMachine(ObjectProvider<Clock>, ApplicationEventPublisher, MomentsProperties) - Method in class org.springframework.modulith.moments.autoconfigure.MomentsAutoConfiguration

TimeMachine - Class in org.springframework.modulith.moments.support

Extension of Moments to publicly expose methods to shift time.

TimeMachine(Clock, ApplicationEventPublisher, MomentsProperties) - Constructor for class org.springframework.modulith.moments.support.TimeMachine

Creates a new TimeMachine for the given Clock, ApplicationEventPublisher and MomentsProperties.

to(ApplicationModule) - Static method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependency

Creates a new ApplicationModule.DeclaredDependency to the unnamed interface of the given ApplicationModule.

toArchitecturallyEvidentType() - Method in class org.springframework.modulith.core.SpringBean

Creates a new ArchitecturallyEvidentType from the current SpringBean.

toArrive() - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Awaits an event of the given specification to arrive.

toArriveAndAssert(BiConsumer<PublishedEventsAssert.PublishedEventAssert<? super E>, T>) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Expects the events previously specified to arrive and additionally assert the PublishedEventsAssert for the captured event and original stimulus result.

toArriveAndAssert(Consumer<PublishedEventsAssert.PublishedEventAssert<? super E>>) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Expects the events previously specified to arrive and additionally assert the PublishedEventsAssert for the captured event.

toArriveAndVerify(BiConsumer<E, T>) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Awaits an event of the given specification to arrive and invokes the given consumer with it as well as the result created by the stimulus.

toArriveAndVerify(Consumer<E>) - Method in class org.springframework.modulith.test.Scenario.When.EventResult

Awaits an event of the given specification to arrive and invokes the given consumer with it.

toAsciidoctor(String) - Method in class org.springframework.modulith.docs.Asciidoctor

toBulletPoint(String) - Method in class org.springframework.modulith.docs.Asciidoctor

toClasses() - Static method in class org.springframework.modulith.core.Classes

Returns a Collector creating a Classes instance from a Stream of JavaType.

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

toJson() - Method in class org.springframework.modulith.core.util.ApplicationModulesExporter

Returns the ApplicationModules structure as JSON String.

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

toOptional() - Method in class org.springframework.modulith.core.Classes

toPlantUml() - Method in class org.springframework.modulith.docs.Documenter

toSingle() - Method in class org.springframework.modulith.core.JavaPackage

Reduces the JavaPackage to only its base package.

toString() - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependencies

toString() - Method in class org.springframework.modulith.core.ApplicationModule.DeclaredDependency

toString() - Method in class org.springframework.modulith.core.ApplicationModule.QualifiedDependency

toString() - Method in class org.springframework.modulith.core.ApplicationModule

toString() - Method in class org.springframework.modulith.core.ApplicationModules

toString() - Method in class org.springframework.modulith.core.ArchitecturallyEvidentType

toString() - Method in class org.springframework.modulith.core.Classes

toString() - Method in class org.springframework.modulith.core.EventType

toString() - Method in class org.springframework.modulith.core.JavaPackage

toString() - Method in class org.springframework.modulith.core.NamedInterface.TypeBasedNamedInterface

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.

toString() - Method in class org.springframework.modulith.events.DefaultEventPublication

toString() - Method in class org.springframework.modulith.events.PublicationTargetIdentifier

toString(Object) - Static method in class org.springframework.modulith.core.util.Json

toString(ApplicationModule) - Method in class org.springframework.modulith.core.JavaAccessSource

toString(ApplicationModule) - Method in interface org.springframework.modulith.core.Source

Renders the source in human readable way.

toString(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule

toViolations() - Static method in exception org.springframework.modulith.core.Violations

A Collector to turn a Stream of RuntimeExceptions into a Violations instance.

tracingModuleEventListener(ApplicationModulesRuntime, ObjectProvider<Tracer>) - Static method in class org.springframework.modulith.observability.autoconfigure.ModuleObservabilityAutoConfiguration

TransactionalEventListeners(Collection<ApplicationListener<?>>) - Constructor for class org.springframework.modulith.events.support.PersistentApplicationEventMulticaster.TransactionalEventListeners

Creates a new PersistentApplicationEventMulticaster.TransactionalEventListeners instance by filtering all elements implementing TransactionalApplicationListener.

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.

TypeBasedNamedInterface(String, Classes, JavaPackage) - Constructor for class org.springframework.modulith.core.NamedInterface.TypeBasedNamedInterface

Creates a new NamedInterface.TypeBasedNamedInterface with the given name, Classes and JavaPackage.

TypedEvents - Interface in org.springframework.modulith.test

Types - Class in org.springframework.modulith.core

Types() - Constructor for class org.springframework.modulith.core.Types

Types.JavaXTypes - Class in org.springframework.modulith.core

Types.JMoleculesTypes - Class in org.springframework.modulith.core

Types.SpringDataTypes - Class in org.springframework.modulith.core

Types.SpringTypes - Class in org.springframework.modulith.core

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.

uniqueStream(Function<ApplicationModuleDependency, Object>) - Method in class org.springframework.modulith.core.ApplicationModuleDependencies

Return all ApplicationModuleDependency instances unique by the value extracted using the given Function.

unnamed(JavaPackage) - Static method in class org.springframework.modulith.core.NamedInterface

Creates an unnamed NamedInterface for the given JavaPackage.

update(CompletableEventPublication) - Method in interface org.springframework.modulith.events.EventPublicationRepository

Update the data store to mark the backing log entry as completed.

update(CompletableEventPublication) - Method in class org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

update(CompletableEventPublication) - Method in class org.springframework.modulith.events.jpa.JpaEventPublicationRepository

update(CompletableEventPublication) - Method in class org.springframework.modulith.events.mongodb.MongoDbEventPublicationRepository

useFullyQualifiedModuleNames() - Method in class org.springframework.modulith.core.AnnotationModulithMetadata

useFullyQualifiedModuleNames() - Method in interface org.springframework.modulith.core.ModulithMetadata

Whether to use fully-qualified module names, i.e.

useFullyQualifiedModuleNames() - Method in class org.springframework.modulith.core.SpringBootModulithMetadata

useFullyQualifiedModuleNames() - Element in annotation interface org.springframework.modulith.Modulith

Whether to use fully qualified module names by default.

useFullyQualifiedModuleNames() - Element in annotation interface org.springframework.modulith.Modulithic

Whether to use fully qualified module names by default.

USES_COMPONENT - Enum constant in enum class org.springframework.modulith.core.DependencyType

Indicates that the module depends on the other one by a component dependency, i.e.

uuidToDatabase(UUID) - Method in enum class org.springframework.modulith.events.jdbc.DatabaseType

V

value() - Element in annotation interface org.springframework.modulith.NamedInterface

The name(s) of the named interface.

value() - Element in annotation interface org.springframework.modulith.test.ApplicationModuleTest

valueOf(String) - Static method in enum class org.springframework.modulith.core.ApplicationModuleDetectionStrategies

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.modulith.core.DependencyDepth

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.modulith.core.DependencyType

Returns the enum constant of this class with the specified name.

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.

valueOf(String) - Static method in enum class org.springframework.modulith.events.jdbc.DatabaseType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.modulith.moments.Quarter

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.modulith.moments.support.MomentsProperties.Granularity

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.modulith.test.ApplicationModuleTest.BootstrapMode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.springframework.modulith.core.ApplicationModuleDetectionStrategies

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.core.DependencyDepth

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.core.DependencyType

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.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.

values() - Static method in enum class org.springframework.modulith.events.jdbc.DatabaseType

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.moments.Quarter

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.moments.support.MomentsProperties.Granularity

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.test.ApplicationModuleTest.BootstrapMode

Returns an array containing the constants of this enum class, in the order they are declared.

verify() - Method in class org.springframework.modulith.core.ApplicationModules

Execute all verifications to be applied, unless the verification has been executed before.

verify() - Method in class org.springframework.modulith.test.ModuleTestExecution

Explicitly trigger the module structure verification.

verifyAutomatically() - Element in annotation interface org.springframework.modulith.test.ApplicationModuleTest

Whether to automatically verify the module structure for validity.

verifyDependencies(ApplicationModules) - Method in class org.springframework.modulith.core.ApplicationModule

verifyModule() - Method in class org.springframework.modulith.test.ModuleTestExecution

Verifies the setup of the module bootstrapped by this execution.

Violations - Exception in org.springframework.modulith.core

Value type to gather and report architectural violations.

VISIBLE - Enum constant in enum class org.springframework.modulith.docs.Documenter.DiagramOptions.ElementsWithoutRelationships

W

WeekHasPassed - Class in org.springframework.modulith.moments

A DomainEvent published if a week has passed.

WeekHasPassed(Year, int, Locale) - Constructor for class org.springframework.modulith.moments.WeekHasPassed

Creates a new WeekHasPassed for the given Year, week and Locale.

When(BiFunction<TransactionOperations, ApplicationEventPublisher, T>, Consumer<T>, Function<ConditionFactory, ConditionFactory>) - Constructor for class org.springframework.modulith.test.Scenario.When

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.

withGranularity(MomentsProperties.Granularity) - Method in class org.springframework.modulith.moments.support.MomentsProperties

withinRootPackages(String) - Method in class org.springframework.modulith.core.ApplicationModules

Returns whether the given type is contained in one of the root packages (not including sub-packages) of the modules.

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.

withLocale(Locale) - Method in class org.springframework.modulith.moments.support.MomentsProperties

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.

withoutModule(String) - Static method in class org.springframework.modulith.core.ApplicationModules.Filters

withoutModules(String...) - Static method in class org.springframework.modulith.core.ApplicationModules.Filters

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.

withType(DependencyType) - Method in class org.springframework.modulith.core.ApplicationModuleDependencies

withZoneId(ZoneId) - Method in class org.springframework.modulith.moments.support.MomentsProperties

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

Y

YearHasPassed - Class in org.springframework.modulith.moments

A DomainEvent published on the last day of the year.

A B C D E F G H I J K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form