Package org.springframework.modulith.core

Class EntryPoints

java.lang.Object

org.springframework.modulith.core.EntryPoints

All Implemented Interfaces:

Iterable<EntryPoints.EntryPoint>

class EntryPoints
extends Object
implements Iterable<EntryPoints.EntryPoint>

All EntryPoints.EntryPoints of an ApplicationModule, i.e. methods or constructors that can trigger module behavior from the outside.

There are two, independent ways for a method to qualify:

• It's publicly accessible and declared on a type exposed by the module, i.e. reachable via a regular Java method call from other modules.
• It's invoked directly by framework infrastructure — an HTTP handler method, an application event listener, or a message listener — regardless of whether its declaring type is exposed, as those are triggered independently of the module's named interfaces.

This is a first, deliberately simple cut. It is expected to evolve, e.g. to cover further messaging technologies or scheduled methods.

Since:

2.2

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	EntryPoints.EntryPoint	A method or constructor that forms an entry point into the ApplicationModule that this EntryPoints instance was created for, i.e. code that can trigger module behavior from the outside, either because it's part of the module's exposed, public API, or because some framework infrastructure invokes it directly.

Method Summary

Modifier and Type	Method	Description
(package private) boolean	contains(com.tngtech.archunit.core.domain.JavaCodeUnit unit)	Returns whether the given JavaCodeUnit forms one of these EntryPoints.EntryPoints.
(package private) <X extends TypeAware> MultiValueMap<EntryPoints.EntryPoint,X>	discover(List<X> candidates)	Filters the given TypeAware candidates down to the ones actually (transitively) reachable from one of these EntryPoints.EntryPoints, returning the EntryPoints.EntryPoints found, each paired with the candidate(s) it potentially triggers the creation of.
(package private) EntryPoints	filter(com.tngtech.archunit.core.domain.JavaClass type)	Returns a new EntryPoints containing only the ones declared on the given type.
(package private) EntryPoints	filter(Class<?> type)	Returns a new EntryPoints containing only the ones declared on the given type.
Iterator<EntryPoints.EntryPoint>	iterator()
(package private) static EntryPoints	of(ApplicationModule module)	Calculates the EntryPoints of the given ApplicationModule.
(package private) Stream<EntryPoints.EntryPoint>	stream()	Returns a Stream of all EntryPoints.EntryPoints.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

of

static EntryPoints of(ApplicationModule module)

Calculates the EntryPoints of the given ApplicationModule.

Parameters:

module - must not be null.

Returns:

will never be null.

contains

boolean contains(com.tngtech.archunit.core.domain.JavaCodeUnit unit)

Returns whether the given JavaCodeUnit forms one of these EntryPoints.EntryPoints.

Parameters:

unit - must not be null.

stream

Stream<EntryPoints.EntryPoint> stream()

Returns a Stream of all EntryPoints.EntryPoints.

Returns:

will never be null.

filter

EntryPoints filter(com.tngtech.archunit.core.domain.JavaClass type)

Returns a new EntryPoints containing only the ones declared on the given type.

Parameters:

type - must not be null.

Returns:

will never be null.

filter

EntryPoints filter(Class<?> type)

Returns a new EntryPoints containing only the ones declared on the given type.

Parameters:

type - must not be null.

Returns:

will never be null.

discover

<X extends TypeAware>
MultiValueMap<EntryPoints.EntryPoint,X> discover(List<X> candidates)

Filters the given TypeAware candidates down to the ones actually (transitively) reachable from one of these EntryPoints.EntryPoints, returning the EntryPoints.EntryPoints found, each paired with the candidate(s) it potentially triggers the creation of.

For each candidate's TypeAware.getCreations(), we walk up the call graph via JavaAccess.getOrigin() and its callers, recording every method along the way that forms one of these EntryPoints.EntryPoints as a potential trigger.

This is a first, deliberately simple cut of the algorithm used to select which of the discovered entry points are eventually surfaced. It is expected to evolve.

Type Parameters:

X - the type of candidate.

Parameters:

candidates - must not be null.

Returns:

will never be null.

iterator

public Iterator<EntryPoints.EntryPoint> iterator()

Specified by:

iterator in interface Iterable<EntryPoints.EntryPoint>