Package org.springframework.modulith.docs

Class CodeReplacingDocumentationSource

java.lang.Object

org.springframework.modulith.docs.CodeReplacingDocumentationSource

All Implemented Interfaces:

DocumentationSource

class CodeReplacingDocumentationSource
extends Object
implements DocumentationSource

A DocumentationSource that replaces {@code …} or {@link …} blocks into inline code references

Author:

Oliver Drotbohm

Constructor Summary

Constructors

Constructor	Description
CodeReplacingDocumentationSource(DocumentationSource delegate, Asciidoctor asciidoctor)	Creates a new CodeReplacingDocumentationSource for the given delegate DocumentationSource and Asciidoctor instance.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDocumentation(com.tngtech.archunit.core.domain.JavaClass type)	Returns the documentation to be used for the given JavaClass.
Optional<String>	getDocumentation(com.tngtech.archunit.core.domain.JavaMethod method)	Returns the documentation to be used for the given JavaMethod.

Methods inherited from class java.lang.Object

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

Constructor Details

CodeReplacingDocumentationSource

CodeReplacingDocumentationSource(DocumentationSource delegate,
 Asciidoctor asciidoctor)

Creates a new CodeReplacingDocumentationSource for the given delegate DocumentationSource and Asciidoctor instance.

Parameters:

delegate - must not be null.

asciidoctor - must not be null.

Method Details

getDocumentation

public Optional<String> getDocumentation(com.tngtech.archunit.core.domain.JavaMethod method)

Description copied from interface: DocumentationSource

Returns the documentation to be used for the given JavaMethod.

Specified by:

getDocumentation in interface DocumentationSource

Parameters:

method - must not be null.

Returns:

will never be null.

getDocumentation

public Optional<String> getDocumentation(com.tngtech.archunit.core.domain.JavaClass type)

Description copied from interface: DocumentationSource

Returns the documentation to be used for the given JavaClass.

Specified by:

getDocumentation in interface DocumentationSource

Parameters:

type - must not be null.

Returns:

will never be null.