Package org.springframework.modulith.core

Class NamedInterfaces

java.lang.Object

org.springframework.modulith.core.NamedInterfaces

All Implemented Interfaces:

Iterable<NamedInterface>

public class NamedInterfaces
extends Object
implements Iterable<NamedInterface>

A collection of NamedInterfaces.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamedInterfaces.Builder	A builder API to manually construct NamedInterfaces instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedInterfaces	NONE

Method Summary

Modifier and Type	Method	Description
NamedInterfaces	and(Iterable<NamedInterface> others)	Creates a new NamedInterfaces instance with the given NamedInterfaces added.
static NamedInterfaces.Builder	builder(JavaPackage basePackage)	Creates a new NamedInterfaces.Builder to eventually create NamedInterfaces for the given base package.
boolean	containsInExplicitInterface(com.tngtech.archunit.core.domain.JavaClass type)	Returns whether the given type is contained in one of the explicitly named NamedInterfaces.
(package private) boolean	containsInExplicitInterface(Class<?> type)
static NamedInterfaces	discoverNamedInterfaces(JavaPackage basePackage)	Discovers all NamedInterfaces declared for the given JavaPackage.
static NamedInterfaces	forOpen(JavaPackage basePackage)	Creates a new NamedInterface consisting of the unnamed one containing all classes in the given JavaPackage.
Optional<NamedInterface>	getByName(String name)	Returns the NamedInterface with the given name if present.
Stream<NamedInterface>	getNamedInterfacesContaining(com.tngtech.archunit.core.domain.JavaClass type)	Returns all named interfaces that contain the given type.
(package private) Stream<NamedInterface>	getNamedInterfacesContaining(Class<?> type)
NamedInterface	getUnnamedInterface()	Returns the unnamed NamedInterface of the module.
boolean	hasExplicitInterfaces()	Returns whether at least one explicit NamedInterface is declared.
Iterator<NamedInterface>	iterator()
(package private) static NamedInterfaces	of(List<NamedInterface> interfaces)	Creates a new NamedInterfaces for the given NamedInterfaces.
static NamedInterfaces	of(JavaPackage basePackage, ApplicationModuleInformation information)
(package private) static NamedInterfaces	ofAnnotatedPackages(JavaPackage basePackage)	Creates a new NamedInterfaces for the given base JavaPackage.
Stream<NamedInterface>	stream()	Create a Stream of NamedInterfaces.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

NONE

public static final NamedInterfaces NONE

Method Details

of

public static NamedInterfaces of(JavaPackage basePackage,
 ApplicationModuleInformation information)

Parameters:

basePackage - must not be null.

information - must not be null.

Returns:

Since:

1.4

discoverNamedInterfaces

public static NamedInterfaces discoverNamedInterfaces(JavaPackage basePackage)

Discovers all NamedInterfaces declared for the given JavaPackage.

Parameters:

basePackage - must not be null.

Returns:

will never be null.

Since:

1.4 (previously package protected)

builder

public static NamedInterfaces.Builder builder(JavaPackage basePackage)

Creates a new NamedInterfaces.Builder to eventually create NamedInterfaces for the given base package.

Parameters:

basePackage - must not be null.

Returns:

will never be null.

of

static NamedInterfaces of(List<NamedInterface> interfaces)

Creates a new NamedInterfaces for the given NamedInterfaces.

Parameters:

interfaces - must not be null.

Returns:

will never be null.

ofAnnotatedPackages

static NamedInterfaces ofAnnotatedPackages(JavaPackage basePackage)

Creates a new NamedInterfaces for the given base JavaPackage.

Parameters:

basePackage - must not be null.

Returns:

will never be null.

forOpen

public static NamedInterfaces forOpen(JavaPackage basePackage)

Creates a new NamedInterface consisting of the unnamed one containing all classes in the given JavaPackage.

Parameters:

basePackage - must not be null.

Returns:

will never be null.

Since:

1.2, public since 1.4

hasExplicitInterfaces

public boolean hasExplicitInterfaces()

Returns whether at least one explicit NamedInterface is declared.

Returns:

will never be null.

stream

public Stream<NamedInterface> stream()

Create a Stream of NamedInterfaces.

Returns:

will never be null.

getByName

public Optional<NamedInterface> getByName(String name)

Returns the NamedInterface with the given name if present.

Parameters:

name - must not be null or empty.

Returns:

will never be null.

getUnnamedInterface

public NamedInterface getUnnamedInterface()

Returns the unnamed NamedInterface of the module.

Returns:

will never be null.

getNamedInterfacesContaining

public Stream<NamedInterface> getNamedInterfacesContaining(com.tngtech.archunit.core.domain.JavaClass type)

Returns all named interfaces that contain the given type.

Parameters:

type - must not be null.

Returns:

will never be null.

containsInExplicitInterface

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

Returns whether the given type is contained in one of the explicitly named NamedInterfaces.

Parameters:

type - must not be null.

Since:

1.2

iterator

public Iterator<NamedInterface> iterator()

Specified by:

iterator in interface Iterable<NamedInterface>

and

public NamedInterfaces and(Iterable<NamedInterface> others)

Creates a new NamedInterfaces instance with the given NamedInterfaces added.

Parameters:

others - must not be null.

Returns:

will never be null.

Since:

1.4 (previously package protected)

getNamedInterfacesContaining

Stream<NamedInterface> getNamedInterfacesContaining(Class<?> type)

containsInExplicitInterface

boolean containsInExplicitInterface(Class<?> type)

toString

public String toString()

Overrides:

toString in class Object