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
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 basePackage)	Given the JavaPackage that Moduliths was initialized with, return the base packages for all modules in the system.

Method Details

getModuleBasePackages

Stream<JavaPackage> getModuleBasePackages(JavaPackage basePackage)

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

Parameters:

basePackage - will never be null.

Returns:

must not be null.

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.