Package org.springframework.modulith.core

Class NamedInterface

java.lang.Object

org.springframework.modulith.core.NamedInterface

All Implemented Interfaces:

Iterable<com.tngtech.archunit.core.domain.JavaClass>

Direct Known Subclasses:

NamedInterface.TypeBasedNamedInterface

public abstract class NamedInterface
extends Object
implements Iterable<com.tngtech.archunit.core.domain.JavaClass>

A named interface into an ApplicationModule. This can either be a package, explicitly annotated with NamedInterface or a set of types annotated with the same annotation. Other ApplicationModules can define allowed dependencies to particular named interfaces via the $moduleName::$namedInterfaceName syntax.

Author:

Oliver Drotbohm

See Also:

• ApplicationModule.allowedDependencies()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamedInterface.TypeBasedNamedInterface

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NamedInterface(String name)	Creates a new NamedInterface with the given name.

Method Summary

Modifier and Type	Method	Description
boolean	contains(com.tngtech.archunit.core.domain.JavaClass type)	Returns whether the NamedInterface contains the given JavaClass.
boolean	contains(Class<?> type)	Returns whether the NamedInterface contains the given type.
protected abstract Classes	getClasses()	Returns all Classes making up this NamedInterface.
String	getName()	Returns the NamedInterface's name.
(package private) boolean	hasSameNameAs(NamedInterface other)	Returns whether the given NamedInterface has the same name as the current one.
boolean	isUnnamed()	Returns whether this is the unnamed (implicit) NamedInterface.
Iterator<com.tngtech.archunit.core.domain.JavaClass>	iterator()
abstract NamedInterface	merge(NamedInterface.TypeBasedNamedInterface other)	Merges the current NamedInterface with the given NamedInterface.TypeBasedNamedInterface.
static NamedInterface.TypeBasedNamedInterface	of(String name, Classes classes, JavaPackage basePackage)	Returns a NamedInterface.TypeBasedNamedInterface with the given name, Classes and base JavaPackage.
static List<NamedInterface>	of(JavaPackage javaPackage)	Returns all NamedInterface.PackageBasedNamedInterfaces for the given JavaPackage.
(package private) static NamedInterface	unnamed(JavaPackage javaPackage)	Creates an unnamed NamedInterface for the given JavaPackage.

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

Field Details

name

protected final String name

Constructor Details

NamedInterface

protected NamedInterface(String name)

Creates a new NamedInterface with the given name.

Parameters:

name - must not be null or empty.

Method Details

of

public static List<NamedInterface> of(JavaPackage javaPackage)

Returns all NamedInterface.PackageBasedNamedInterfaces for the given JavaPackage.

Parameters:

javaPackage - must not be null.

Returns:

will never be null.

of

public static NamedInterface.TypeBasedNamedInterface of(String name,
 Classes classes,
 JavaPackage basePackage)

Returns a NamedInterface.TypeBasedNamedInterface with the given name, Classes and base JavaPackage.

Parameters:

name - must not be null or empty.

classes - must not be null.

basePackage - must not be null.

Returns:

will never be null.

unnamed

static NamedInterface unnamed(JavaPackage javaPackage)

Creates an unnamed NamedInterface for the given JavaPackage.

Parameters:

javaPackage - must not be null.

Returns:

will never be null.

getName

public String getName()

Returns the NamedInterface's name.

Returns:

will never be null or empty.

isUnnamed

public boolean isUnnamed()

Returns whether this is the unnamed (implicit) NamedInterface.

contains

public boolean contains(com.tngtech.archunit.core.domain.JavaClass type)

Returns whether the NamedInterface contains the given JavaClass.

Parameters:

type - must not be null.

contains

public boolean contains(Class<?> type)

Returns whether the NamedInterface contains the given type.

Parameters:

type - must not be null.

hasSameNameAs

boolean hasSameNameAs(NamedInterface other)

Returns whether the given NamedInterface has the same name as the current one.

Parameters:

other - must not be null.

iterator

public Iterator<com.tngtech.archunit.core.domain.JavaClass> iterator()

Specified by:

iterator in interface Iterable<com.tngtech.archunit.core.domain.JavaClass>

getClasses

protected abstract Classes getClasses()

Returns all Classes making up this NamedInterface.

Returns:

will never be null.

merge

public abstract NamedInterface merge(NamedInterface.TypeBasedNamedInterface other)

Merges the current NamedInterface with the given NamedInterface.TypeBasedNamedInterface.

Parameters:

other - must not be null.

Returns:

will never be null.