Package org.springframework.modulith.docs

Class Asciidoctor

java.lang.Object

org.springframework.modulith.docs.Asciidoctor

class Asciidoctor
extends Object

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
String	renderBeanReferences(ApplicationModule module)
String	renderConfigurationProperties(List<ConfigurationProperties.ModuleProperty> properties)
String	renderEvents(ApplicationModule module)
String	renderGeneralInclude(String componentsFilename)
String	renderHeadline(int i, String modules)
String	renderPlantUmlInclude(String componentsFilename)
String	renderSpringBeans(ApplicationModule module, Documenter.CanvasOptions options)
static String	startOrEndTable()
static String	startTable(String tableSpec)
String	toAsciidoctor(String source)
String	toBulletPoint(String source)
String	toInlineCode(com.tngtech.archunit.core.domain.JavaClass type)
String	toInlineCode(String source)	Turns the given source string into inline code.
String	toInlineCode(SpringBean bean)
String	typesToBulletPoints(List<com.tngtech.archunit.core.domain.JavaClass> types)
static Asciidoctor	withJavadocBase(ApplicationModules modules, String javadocBase)	Creates a new Asciidoctor instance for the given ApplicationModules and Javadoc base URI.
static Asciidoctor	withoutJavadocBase(ApplicationModules modules)	Creates a new Asciidoctor instance for the given ApplicationModules.
static String	writeTableRow(String... columns)

Methods inherited from class java.lang.Object

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

Method Details

withJavadocBase

public static Asciidoctor withJavadocBase(ApplicationModules modules,
 @Nullable
 String javadocBase)

Creates a new Asciidoctor instance for the given ApplicationModules and Javadoc base URI.

Parameters:

modules - must not be null.

javadocBase - can be null.

Returns:

will never be null.

withoutJavadocBase

public static Asciidoctor withoutJavadocBase(ApplicationModules modules)

Creates a new Asciidoctor instance for the given ApplicationModules.

Parameters:

modules - must not be null.

Returns:

will never be null.

toInlineCode

public String toInlineCode(String source)

Turns the given source string into inline code.

Parameters:

source - must not be null.

Returns:

toInlineCode

public String toInlineCode(com.tngtech.archunit.core.domain.JavaClass type)

toInlineCode

public String toInlineCode(SpringBean bean)

renderSpringBeans

public String renderSpringBeans(ApplicationModule module,
 Documenter.CanvasOptions options)

renderEvents

public String renderEvents(ApplicationModule module)

renderConfigurationProperties

public String renderConfigurationProperties(List<ConfigurationProperties.ModuleProperty> properties)

typesToBulletPoints

public String typesToBulletPoints(List<com.tngtech.archunit.core.domain.JavaClass> types)

toBulletPoint

public String toBulletPoint(String source)

startTable

public static String startTable(String tableSpec)

startOrEndTable

public static String startOrEndTable()

writeTableRow

public static String writeTableRow(String... columns)

toAsciidoctor

public String toAsciidoctor(String source)

renderBeanReferences

public String renderBeanReferences(ApplicationModule module)

Parameters:

module -

Returns:

renderHeadline

public String renderHeadline(int i,
 String modules)

renderPlantUmlInclude

public String renderPlantUmlInclude(String componentsFilename)

renderGeneralInclude

public String renderGeneralInclude(String componentsFilename)