Package org.springframework.modulith.core

Class ApplicationModuleSource

java.lang.Object

org.springframework.modulith.core.ApplicationModuleSource

public class ApplicationModuleSource
extends Object

The source of an ApplicationModule. Essentially a JavaPackage and associated naming strategy for the module. This will be used when constructing sources from a base package and an ApplicationModuleDetectionStrategy so that the names of the module to be created for the detected packages become the trailing name underneath the base package. For example, scanning from com.acme, an ApplicationModule located in com.acme.foo.bar would be named foo.bar.

Since:

1.3

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ApplicationModuleSource	from(JavaPackage pkg, String name)	Creates a new ApplicationModuleSource for the given JavaPackage and name.
static Stream<ApplicationModuleSource>	from(JavaPackage pkg, ApplicationModuleDetectionStrategy strategy, boolean fullyQualifiedModuleNames)	Returns a Stream of ApplicationModuleSources by applying the given ApplicationModuleDetectionStrategy to the given base package.
JavaPackage	getModuleBasePackage()
String	getModuleName()
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Details

from

public static Stream<ApplicationModuleSource> from(JavaPackage pkg,
 ApplicationModuleDetectionStrategy strategy,
 boolean fullyQualifiedModuleNames)

Returns a Stream of ApplicationModuleSources by applying the given ApplicationModuleDetectionStrategy to the given base package.

Parameters:

pkg - must not be null.

strategy - must not be null.

fullyQualifiedModuleNames - whether to use fully qualified module names.

Returns:

will never be null.

from

public static ApplicationModuleSource from(JavaPackage pkg,
 String name)

Creates a new ApplicationModuleSource for the given JavaPackage and name.

Parameters:

pkg - must not be null.

name - must not be null or empty.

Returns:

will never be null.

getModuleBasePackage

public JavaPackage getModuleBasePackage()

Returns:

will never be null.

getModuleName

public String getModuleName()

Returns:

will never be null or empty.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object