Package org.springframework.modulith.core

Interface ApplicationModuleDetectionStrategy

public interface ApplicationModuleDetectionStrategy

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

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
default NamedInterfaces	detectNamedInterfaces(JavaPackage basePackage, ApplicationModuleInformation information)	Optionally customize the detection of NamedInterfaces for a module with the given base package and the pre-obtained ApplicationModuleInformation.
static ApplicationModuleDetectionStrategy	directSubPackage()	A ApplicationModuleDetectionStrategy that considers all direct sub-packages of the Moduliths base package to be module base packages.
static ApplicationModuleDetectionStrategy	explicitlyAnnotated()	A ApplicationModuleDetectionStrategy that considers packages explicitly annotated with ApplicationModule module base packages.
static ApplicationModuleDetectionStrategy	explictlyAnnotated()	Deprecated, for removal: This API element is subject to removal in a future version. since 1.3.
Stream<JavaPackage>	getModuleBasePackages(JavaPackage rootPackage)	Given the JavaPackage that Spring Modulith was initialized with, return the base packages that are supposed to be considered base packages for ApplicationModules.

Method Details

getModuleBasePackages

Stream<JavaPackage> getModuleBasePackages(JavaPackage rootPackage)

Given the JavaPackage that Spring Modulith was initialized with, return the base packages that are supposed to be considered base packages for ApplicationModules.

Parameters:

rootPackage - will never be null.

Returns:

must not be null.

detectNamedInterfaces

default NamedInterfaces detectNamedInterfaces(JavaPackage basePackage,
 ApplicationModuleInformation information)

Optionally customize the detection of NamedInterfaces for a module with the given base package and the pre-obtained ApplicationModuleInformation. Defaults to NamedInterfaces.of(JavaPackage, ApplicationModuleInformation). NamedInterfaces exposes a NamedInterfaces.Builder API to define the selection of packages to be considered named interfaces.

Parameters:

basePackage - will never be null.

information - will never be null.

Returns:

must not be null.

Since:

1.4

See Also:

• NamedInterfaces.of(JavaPackage, ApplicationModuleInformation)
• NamedInterfaces.builder(JavaPackage)

directSubPackage

static ApplicationModuleDetectionStrategy directSubPackage()

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

Returns:

will never be null.

explictlyAnnotated

@Deprecated(forRemoval=true)
static ApplicationModuleDetectionStrategy explictlyAnnotated()

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

since 1.3. Use explicitlyAnnotated() instead.

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

Returns:

will never be null.

explicitlyAnnotated

static ApplicationModuleDetectionStrategy explicitlyAnnotated()

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

Returns:

will never be null.