Package org.springframework.modulith.core

Interface ApplicationModuleSource.ApplicationModuleSourceMetadata

Enclosing class:

ApplicationModuleSource

static interface ApplicationModuleSource.ApplicationModuleSourceMetadata

An intermediate abstraction to detect both the ApplicationModuleIdentifier and potentially nested module declarations for the JavaPackages returned from the first pass of module detection.

Author:

Oliver Drotbohm

See Also:

• ApplicationModuleDetectionStrategy

Method Summary

Modifier and Type	Method	Description
static <T extends Annotation> ApplicationModuleSource.ApplicationModuleSourceMetadata	forAnnotation(Class<T> annotation, Function<T,String> extractor)	Creates a new ApplicationModuleSourceFactory detecting the ApplicationModuleIdentifier based on a particular annotation's attribute.
Optional<ApplicationModuleIdentifier>	lookupIdentifier(JavaPackage pkg)	Returns an optional ApplicationModuleIdentifier obtained by the annotation on the given package.
Stream<JavaPackage>	withNestedPackages(JavaPackage pkg)	Return a Stream of JavaPackages that are

Method Details

lookupIdentifier

Optional<ApplicationModuleIdentifier> lookupIdentifier(JavaPackage pkg)

Returns an optional ApplicationModuleIdentifier obtained by the annotation on the given package.

Parameters:

pkg - must not be null.

Returns:

will never be null.

withNestedPackages

Stream<JavaPackage> withNestedPackages(JavaPackage pkg)

Return a Stream of JavaPackages that are

Parameters:

pkg - must not be null.

Returns:

will never be null.

forAnnotation

static <T extends Annotation>
ApplicationModuleSource.ApplicationModuleSourceMetadata forAnnotation(Class<T> annotation,
 Function<T,String> extractor)

Creates a new ApplicationModuleSourceFactory detecting the ApplicationModuleIdentifier based on a particular annotation's attribute. It also detects nested JavaPackages annotated with the given annotation as nested module base packages.

Type Parameters:

T - an annotation type

Parameters:

annotation - must not be null.

extractor - must not be null.

Returns:

will never be null.