Package org.springframework.modulith.docs

Enum Class SpringAutoRestDocsDocumentationSource

java.lang.Object

java.lang.Enum<SpringAutoRestDocsDocumentationSource>

org.springframework.modulith.docs.SpringAutoRestDocsDocumentationSource

All Implemented Interfaces:

Serializable, Comparable<SpringAutoRestDocsDocumentationSource>, Constable, DocumentationSource

@Deprecated
enum SpringAutoRestDocsDocumentationSource
extends Enum<SpringAutoRestDocsDocumentationSource>
implements DocumentationSource

Deprecated.

since 1.3, use SpringModulithDocumentationSource instead.

A DocumentationSource that uses metadata generated by Spring Auto REST Docs' Javadoc Doclet.

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SpringAutoRestDocsDocumentationSource.ClassJavadoc	Deprecated.
(package private) static class	SpringAutoRestDocsDocumentationSource.JavadocReader	Deprecated.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Deprecated.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDocumentation(com.tngtech.archunit.core.domain.JavaClass type)	Deprecated. Returns the documentation to be used for the given JavaClass.
Optional<String>	getDocumentation(com.tngtech.archunit.core.domain.JavaMethod method)	Deprecated. Returns the documentation to be used for the given JavaMethod.
static SpringAutoRestDocsDocumentationSource	valueOf(String name)	Deprecated. Returns the enum constant of this class with the specified name.
static SpringAutoRestDocsDocumentationSource[]	values()	Deprecated. Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final SpringAutoRestDocsDocumentationSource INSTANCE

Deprecated.

Method Details

values

public static SpringAutoRestDocsDocumentationSource[] values()

Deprecated.

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SpringAutoRestDocsDocumentationSource valueOf(String name)

Deprecated.

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDocumentation

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

Deprecated.

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)

Deprecated.

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.