Package org.springframework.modulith.core

Class JavaPackages

java.lang.Object

org.springframework.modulith.core.JavaPackages

All Implemented Interfaces:

Iterable<JavaPackage>

class JavaPackages
extends Object
implements Iterable<JavaPackage>

A collection of JavaPackages.

Since:

1.3

Author:

Oliver Drotbohm

Field Summary

Fields

Modifier and Type	Field	Description
static JavaPackages	NONE

Constructor Summary

Constructors

Constructor	Description
JavaPackages(Collection<JavaPackage> packages)	Creates a new JavaPackages instance for the given JavaPackages.
JavaPackages(JavaPackage... packages)	Creates a new JavaPackages instance for the given JavaPackages.

Method Summary

Modifier and Type	Method	Description
(package private) JavaPackages	flatten()	Returns a JavaPackages instance that only contains the primary packages contained in the current JavaPackages.
(package private) JavaPackages	getSubPackagesOf(JavaPackage pkg)	Returns all JavaPackages that are a sub-package of the given one.
Iterator<JavaPackage>	iterator()
(package private) Stream<JavaPackage>	stream()	Returns a stream of JavaPackages.
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 JavaPackages NONE

Constructor Details

JavaPackages

JavaPackages(Collection<JavaPackage> packages)

Creates a new JavaPackages instance for the given JavaPackages.

Parameters:

packages - must not be null.

JavaPackages

JavaPackages(JavaPackage... packages)

Creates a new JavaPackages instance for the given JavaPackages.

Parameters:

packages - must not be null.

Method Details

flatten

JavaPackages flatten()

Returns a JavaPackages instance that only contains the primary packages contained in the current JavaPackages. Any package that's a sub-package of any other package will get dropped.

In other words for a list of {code com.foo}, com.bar, and com.foo.bar, only com.foo and com.bar will be retained.

Returns:

will never be null.

stream

Stream<JavaPackage> stream()

Returns a stream of JavaPackages.

Returns:

will never be null.

getSubPackagesOf

JavaPackages getSubPackagesOf(JavaPackage pkg)

Returns all JavaPackages that are a sub-package of the given one.

Parameters:

pkg - must not be null.

Returns:

will never be null.

Since:

1.4.2

iterator

public Iterator<JavaPackage> iterator()

Specified by:

iterator in interface Iterable<JavaPackage>

toString

public String toString()

Overrides:

toString in class Object