Package org.infinispan.protostream.annotations.impl.types

Class DocumentationExtractor

java.lang.Object

org.infinispan.protostream.annotations.impl.types.DocumentationExtractor

public final class DocumentationExtractor
extends Object

Since:

3.0

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROTOSTREAM_ANNOTATIONS_PREFIX

Constructor Summary

Constructors

Constructor	Description
DocumentationExtractor()

Method Summary

Modifier and Type	Method	Description
static String	getDocumentation(Class<?> clazz, boolean fullyQualified)
static String	getDocumentation(Field f, boolean fullyQualified)
static String	getDocumentation(Method method, boolean fullyQualified)
static String	getDocumentation(Element element, boolean fullyQualified)	Collect and concatenate the description text from an element (type, field, method).

Methods inherited from class java.lang.Object

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

Field Detail

PROTOSTREAM_ANNOTATIONS_PREFIX

public static final String PROTOSTREAM_ANNOTATIONS_PREFIX

See Also:

Constant Field Values

Constructor Detail

DocumentationExtractor

public DocumentationExtractor()

Method Detail

getDocumentation

public static String getDocumentation(Element element,
                                      boolean fullyQualified)

Collect and concatenate the description text from an element (type, field, method). This unwraps @ProtoDoc.values and copies other annotations as-is. The beginning and trailing empty lines are trimmed off. If the resulting documentation text does not have any line then null is returned.

getDocumentation

public static String getDocumentation(Field f,
                                      boolean fullyQualified)

getDocumentation

public static String getDocumentation(Class<?> clazz,
                                      boolean fullyQualified)

getDocumentation

public static String getDocumentation(Method method,
                                      boolean fullyQualified)