Package org.springframework.modulith.docs

Class Documenter.CanvasOptions

java.lang.Object

org.springframework.modulith.docs.Documenter.CanvasOptions

Enclosing class:

Documenter

public static class Documenter.CanvasOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Documenter.CanvasOptions.Grouping
(package private) static class	Documenter.CanvasOptions.Groupings

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Documenter.CanvasOptions.Grouping	FALLBACK_GROUP

Constructor Summary

Constructors

Constructor	Description
CanvasOptions(List<Documenter.CanvasOptions.Grouping> groupers, String apiBase, String targetFileName, boolean hideInternals, boolean hideEmptyLines)

Method Summary

Modifier and Type	Method	Description
static Documenter.CanvasOptions	defaults()	Creates a default Documenter.CanvasOptions instance configuring component Documenter.CanvasOptions.Groupings for jMolecules (if on the classpath) and Spring Framework.
(package private) String	getApiBase()
(package private) Documenter.CanvasOptions.Groupings	groupBeans(ApplicationModule module)
Documenter.CanvasOptions	groupingBy(String name, Predicate<SpringBean> filter)	Registers a component grouping with the given name and selecting filter.
Documenter.CanvasOptions	groupingBy(String name, Predicate<SpringBean> filter, String description)	Registers a component grouping with the given name, selecting filter and description.
Documenter.CanvasOptions	groupingBy(Documenter.CanvasOptions.Grouping... groupings)	Creates a new Documenter.CanvasOptions with the given Documenter.CanvasOptions.Groupings added.
(package private) Predicate<com.tngtech.archunit.core.domain.JavaClass>	hideInternalFilter(ApplicationModule module)
Documenter.CanvasOptions	revealEmptyLines()	Enables table rows not containing any values to be retained in the output.
Documenter.CanvasOptions	revealInternals()	Enables the inclusion of internal components in the module canvas.
Documenter.CanvasOptions	withApiBase(String apiBase)	Configures a URI string to act as the base of the Javadoc accessible for the types contained in the canvas.
static Documenter.CanvasOptions	withoutDefaultGroupings()	Creates a Documenter.CanvasOptions instance that does not register any default component Documenter.CanvasOptions.Groupings.
Documenter.CanvasOptions	withTargetFileName(String targetFileName)	Configures the target file name for the canvas to be written.

Methods inherited from class java.lang.Object

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

Field Details

FALLBACK_GROUP

static final Documenter.CanvasOptions.Grouping FALLBACK_GROUP

Constructor Details

CanvasOptions

CanvasOptions(List<Documenter.CanvasOptions.Grouping> groupers,
 @Nullable
 String apiBase,
 @Nullable
 String targetFileName,
 boolean hideInternals,
 boolean hideEmptyLines)

Method Details

defaults

public static Documenter.CanvasOptions defaults()

Creates a default Documenter.CanvasOptions instance configuring component Documenter.CanvasOptions.Groupings for jMolecules (if on the classpath) and Spring Framework. Use withoutDefaultGroupings() if you prefer to register component Documenter.CanvasOptions.Groupings yourself.

Returns:

will never be null.

See Also:

• withoutDefaultGroupings()
• Documenter.CanvasOptions.Groupings

withoutDefaultGroupings

public static Documenter.CanvasOptions withoutDefaultGroupings()

Creates a Documenter.CanvasOptions instance that does not register any default component Documenter.CanvasOptions.Groupings.

Returns:

will never be null.

See Also:

• defaults()
• Documenter.CanvasOptions.Groupings

groupingBy

public Documenter.CanvasOptions groupingBy(Documenter.CanvasOptions.Grouping... groupings)

Creates a new Documenter.CanvasOptions with the given Documenter.CanvasOptions.Groupings added.

Parameters:

groupings - must not be null.

Returns:

will never be null.

groupingBy

public Documenter.CanvasOptions groupingBy(String name,
 Predicate<SpringBean> filter)

Registers a component grouping with the given name and selecting filter.

Parameters:

name - must not be null or empty.

filter - must not be null.

Returns:

will never be null.

groupingBy

public Documenter.CanvasOptions groupingBy(String name,
 Predicate<SpringBean> filter,
 String description)

Registers a component grouping with the given name, selecting filter and description.

Parameters:

name - must not be null or empty.

filter - must not be null.

description - must not be null or empty.

Returns:

will never be null.

revealInternals

public Documenter.CanvasOptions revealInternals()

Enables the inclusion of internal components in the module canvas.

Returns:

will never be null.

revealEmptyLines

public Documenter.CanvasOptions revealEmptyLines()

Enables table rows not containing any values to be retained in the output. By default, no table rows for e.g. aggregates will be rendered if none are found in the ApplicationModule.

Returns:

will never be null.

withApiBase

public Documenter.CanvasOptions withApiBase(String apiBase)

Configures a URI string to act as the base of the Javadoc accessible for the types contained in the canvas. If set, the output will add links to the Javadoc for those types.

Parameters:

apiBase - must not be null or empty.

Returns:

will never be null.

withTargetFileName

public Documenter.CanvasOptions withTargetFileName(String targetFileName)

Configures the target file name for the canvas to be written. Defaults to module-$moduleName.adoc.

Parameters:

targetFileName - must not be null or empty.

Returns:

will never be null.

getApiBase

String getApiBase()

groupBeans

Documenter.CanvasOptions.Groupings groupBeans(ApplicationModule module)

hideInternalFilter

Predicate<com.tngtech.archunit.core.domain.JavaClass> hideInternalFilter(ApplicationModule module)