Package org.springframework.modulith.core

Class AnnotationModulithMetadata

java.lang.Object

org.springframework.modulith.core.AnnotationModulithMetadata

All Implemented Interfaces:

ModulithMetadata

class AnnotationModulithMetadata
extends Object
implements ModulithMetadata

ModulithMetadata backed by a Modulithic annotated type.

Author:

Oliver Drotbohm

Field Summary

Fields inherited from interface org.springframework.modulith.core.ModulithMetadata

ANNOTATION_MISSING, WITH_ANNOTATIONS

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalPackages()	Returns the names of the packages that are supposed to be considered modulith base packages, i.e. for which to consider all direct sub-packages modules by default.
List<String>	getBasePackages()	Returns all base packages of the modulith.
Object	getModulithSource()	Returns the source of the Spring Modulith setup.
Stream<ApplicationModuleIdentifier>	getSharedModuleIdentifiers()	Returns the ApplicationModuleIdentifiers of shared modules, i.e. modules that are supposed to always be included in bootstraps.
Stream<String>	getSharedModuleNames()	Returns the name of shared modules, i.e. modules that are supposed to always be included in bootstraps.
Object	getSource()	Returns the source of the Spring Modulith setup.
Optional<String>	getSystemName()	Returns the name of the system.
static Optional<ModulithMetadata>	of(Class<?> annotated)	Creates a ModulithMetadata inspecting Modulithic annotation or return Optional.empty() if the type given does not carry the annotation.
boolean	useFullyQualifiedModuleNames()	Whether to use fully-qualified module names, i.e. rather use the fully-qualified package name instead of the local one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

public static Optional<ModulithMetadata> of(Class<?> annotated)

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

Parameters:

annotated - must not be null.

Returns:

getModulithSource

public Object getModulithSource()

Description copied from interface: ModulithMetadata

Returns the source of the Spring Modulith setup. Either a type or a package.

Specified by:

getModulithSource in interface ModulithMetadata

Returns:

will never be null.

getSource

public Object getSource()

Description copied from interface: ModulithMetadata

Returns the source of the Spring Modulith setup. Either a type or a package.

Specified by:

getSource in interface ModulithMetadata

Returns:

will never be null.

getAdditionalPackages

public List<String> getAdditionalPackages()

Description copied from interface: ModulithMetadata

Returns the names of the packages that are supposed to be considered modulith base packages, i.e. for which to consider all direct sub-packages modules by default.

Specified by:

getAdditionalPackages in interface ModulithMetadata

Returns:

will never be null.

useFullyQualifiedModuleNames

public boolean useFullyQualifiedModuleNames()

Description copied from interface: ModulithMetadata

Whether to use fully-qualified module names, i.e. rather use the fully-qualified package name instead of the local one.

Specified by:

useFullyQualifiedModuleNames in interface ModulithMetadata

Returns:

getSharedModuleNames

public Stream<String> getSharedModuleNames()

Description copied from interface: ModulithMetadata

Returns the name of shared modules, i.e. modules that are supposed to always be included in bootstraps.

Specified by:

getSharedModuleNames in interface ModulithMetadata

Returns:

will never be null.

getSharedModuleIdentifiers

public Stream<ApplicationModuleIdentifier> getSharedModuleIdentifiers()

Description copied from interface: ModulithMetadata

Returns the ApplicationModuleIdentifiers of shared modules, i.e. modules that are supposed to always be included in bootstraps.

Specified by:

getSharedModuleIdentifiers in interface ModulithMetadata

Returns:

will never be null.

getSystemName

public Optional<String> getSystemName()

Description copied from interface: ModulithMetadata

Returns the name of the system.

Specified by:

getSystemName in interface ModulithMetadata

Returns:

will never be null.

getBasePackages

public List<String> getBasePackages()

Description copied from interface: ModulithMetadata

Returns all base packages of the modulith.

Specified by:

getBasePackages in interface ModulithMetadata

Returns:

will never be null.