Package org.springframework.modulith.docs

Class Documenter.CanvasOptions.Grouping

java.lang.Object

org.springframework.modulith.docs.Documenter.CanvasOptions.Grouping

Enclosing class:

Documenter.CanvasOptions

public static class Documenter.CanvasOptions.Grouping
extends Object

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the Documenter.CanvasOptions.Grouping.
String	getName()	Returns the name of the Documenter.CanvasOptions.Grouping.
static Predicate<SpringBean>	implementing(Class<?> type)	Helper method to create a Predicate for SpringBeans implementing the given interface.
boolean	matches(SpringBean candidate)	Returns whether the given SpringBean matches the Documenter.CanvasOptions.Grouping.
static Predicate<SpringBean>	nameMatching(String pattern)	Helper method to create a Predicate for SpringBeans matching the given name pattern.
static Documenter.CanvasOptions.Grouping	of(String name)	Deprecated. no replacement as a name-only Documenter.CanvasOptions.Grouping doesn't make any sense in the first place.
static Documenter.CanvasOptions.Grouping	of(String name, Predicate<SpringBean> predicate)	Creates a Documenter.CanvasOptions.Grouping with the given name and selecting Predicate.
static Documenter.CanvasOptions.Grouping	of(String name, Predicate<SpringBean> predicate, String description)	Creates a Documenter.CanvasOptions.Grouping with the given name, selecting Predicate and description.
static Predicate<SpringBean>	subtypeOf(Class<?> type)	Helper method to create a Predicate for SpringBeans that are a subtype of the given one.

Methods inherited from class java.lang.Object

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

Method Details

of

@Deprecated
public static Documenter.CanvasOptions.Grouping of(String name)

Deprecated.

no replacement as a name-only Documenter.CanvasOptions.Grouping doesn't make any sense in the first place.

Creates a Documenter.CanvasOptions.Grouping with the given name.

Parameters:

name - must not be null or empty.

Returns:

will never be null.

of

public static Documenter.CanvasOptions.Grouping of(String name,
 Predicate<SpringBean> predicate)

Creates a Documenter.CanvasOptions.Grouping with the given name and selecting Predicate.

Parameters:

name - must not be null or empty.

predicate - must not be null.

Returns:

will never be null.

of

public static Documenter.CanvasOptions.Grouping of(String name,
 Predicate<SpringBean> predicate,
 String description)

Creates a Documenter.CanvasOptions.Grouping with the given name, selecting Predicate and description.

Parameters:

name - must not be null or empty.

predicate - must not be null.

description - must not be null or empty.

Returns:

will never be null.

nameMatching

public static Predicate<SpringBean> nameMatching(String pattern)

Helper method to create a Predicate for SpringBeans matching the given name pattern.

Parameters:

pattern - must not be null or empty.

Returns:

will never be null.

implementing

public static Predicate<SpringBean> implementing(Class<?> type)

Helper method to create a Predicate for SpringBeans implementing the given interface.

Parameters:

type - must not be null.

Returns:

will never be null.

subtypeOf

public static Predicate<SpringBean> subtypeOf(Class<?> type)

Helper method to create a Predicate for SpringBeans that are a subtype of the given one. In other words, implement or extend it but are not the type itself.

Parameters:

type - must not be null.

Returns:

will never be null.

getName

public String getName()

Returns the name of the Documenter.CanvasOptions.Grouping.

Returns:

will never be null or empty.

getDescription

@Nullable
public String getDescription()

Returns the description of the Documenter.CanvasOptions.Grouping.

Returns:

can be null.

matches

public boolean matches(SpringBean candidate)

Returns whether the given SpringBean matches the Documenter.CanvasOptions.Grouping.

Parameters:

candidate - must not be null.