Package io.debezium.operator.docs

Class AbstractDocsProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.debezium.operator.docs.AbstractDocsProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

DebeziumOperatorDocsProcessor

public abstract class AbstractDocsProcessor
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field	Description
private final Documentation	documentation
private final String	file
private final Set<String>	knownTypes

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
AbstractDocsProcessor(String file, String title)

Method Summary

Modifier and Type	Method	Description
protected List<Documented.Field>	additionalFields(TypeElement element)
protected Documentation.FieldDescription	createFieldDocs(Documented.Field field)	Called for each field documented by Documented.Field
protected Documentation.FieldDescription	createFieldDocs(VariableElement field)	Called for each field documented by JsonPropertyDescription
protected Optional<String>	declaredTypeName(TypeMirror mirror)
protected Optional<Documented.Field>	documentedFieldInfo(Element element)
protected Optional<Documented>	documentedTypeInfo(TypeElement type)
protected Optional<Documented>	documentedTypeInfo(TypeMirror type)
protected Documentation.TypeDescription	documentType(TypeElement element)
protected void	documentTypes(Collection<TypeElement> types)
protected List<String>	enumConstantNames(TypeElement type)
protected Optional<String>	enumTypeName(TypeMirror type)
protected Optional<String>	explicitFieldTypeName(VariableElement field)	Extracts type documented by Documented.Field
protected Optional<String>	explicitTypeName(TypeMirror type)
protected String	fieldDefaultValue(Element element)
protected String	fieldDescription(Element element)	Gets descriptions from JsonPropertyDescription
protected String	fieldExternalTypeReference(Documented.Field field)
protected String	fieldExternalTypeReference(VariableElement field)	Extracts external type reference URL from Documented.Field present on a field
protected String	fieldType(VariableElement field)
protected String	fieldTypeReference(VariableElement field)	Extracts a type reference from a field's type.
protected abstract DocumentationFormatter	formatter()	Creates an appropriate instance of documentation formatter
protected String	genericTypeName(DeclaredType type)
Set<String>	getSupportedAnnotationTypes()
protected boolean	isDocumentedField(Element field)
protected boolean	isKnownType(String name)
protected boolean	isNotHidden(TypeElement element)
protected Optional<com.fasterxml.jackson.annotation.JsonProperty>	jsonProperty(Element element)
protected Optional<com.fasterxml.jackson.annotation.JsonPropertyDescription>	jsonPropertyDescription(Element element)
protected Optional<String>	k8TypeReference(String slug)
protected String	name(Element element)
protected String	name(TypeElement type)
protected List<VariableElement>	presentFields(TypeElement element)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private void	setKnownTypes(Collection<TypeElement> types)
protected String	simpleName(String fullName)	For a fully qualified name, this method returns the part after the last dot
protected Optional<String>	typeArgumentReference(TypeMirror type)
protected Documentation.TypeDescriptionBuilder	typeDescriptionBuilder(String name)	Creates an appropriate instance of type description builder
protected Optional<String>	typeErasureReference(TypeMirror type)
protected String	typeName(TypeMirror type)
protected void	writeDocFile(String fileName)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, getSupportedSourceVersion, init, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

documentation

private final Documentation documentation

file

private final String file

knownTypes

private final Set<String> knownTypes

Constructor Details

AbstractDocsProcessor

public AbstractDocsProcessor(String file,
 String title)

Method Details

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

writeDocFile

protected void writeDocFile(String fileName)

documentTypes

protected void documentTypes(Collection<TypeElement> types)

documentType

protected Documentation.TypeDescription documentType(TypeElement element)

additionalFields

protected List<Documented.Field> additionalFields(TypeElement element)

presentFields

protected List<VariableElement> presentFields(TypeElement element)

setKnownTypes

private void setKnownTypes(Collection<TypeElement> types)

name

protected String name(TypeElement type)

Parameters:

type - type given as TypeElement instance

Returns:

name of the type

name

protected String name(Element element)

Returns:

name of the element

simpleName

protected String simpleName(String fullName)

For a fully qualified name, this method returns the part after the last dot

Parameters:

fullName - fully qualified name

Returns:

simple name

documentedFieldInfo

protected Optional<Documented.Field> documentedFieldInfo(Element element)

jsonPropertyDescription

protected Optional<com.fasterxml.jackson.annotation.JsonPropertyDescription> jsonPropertyDescription(Element element)

jsonProperty

protected Optional<com.fasterxml.jackson.annotation.JsonProperty> jsonProperty(Element element)

documentedTypeInfo

protected Optional<Documented> documentedTypeInfo(TypeMirror type)

documentedTypeInfo

protected Optional<Documented> documentedTypeInfo(TypeElement type)

isDocumentedField

protected boolean isDocumentedField(Element field)

isNotHidden

protected boolean isNotHidden(TypeElement element)

isKnownType

protected boolean isKnownType(String name)

fieldDefaultValue

protected String fieldDefaultValue(Element element)

fieldDescription

protected String fieldDescription(Element element)

Gets descriptions from JsonPropertyDescription

Parameters:

element - annotated element

Returns:

field description

fieldType

protected String fieldType(VariableElement field)

Parameters:

field - variable field

Returns:

type with generic arguments

explicitFieldTypeName

protected Optional<String> explicitFieldTypeName(VariableElement field)

Extracts type documented by Documented.Field

Parameters:

field - scanned field

Returns:

documented type or empty

explicitTypeName

protected Optional<String> explicitTypeName(TypeMirror type)

enumTypeName

protected Optional<String> enumTypeName(TypeMirror type)

declaredTypeName

protected Optional<String> declaredTypeName(TypeMirror mirror)

typeName

protected String typeName(TypeMirror type)

genericTypeName

protected String genericTypeName(DeclaredType type)

enumConstantNames

protected List<String> enumConstantNames(TypeElement type)

fieldTypeReference

protected String fieldTypeReference(VariableElement field)

Extracts a type reference from a field's type.

Parameters:

field - variable element

Returns:

name of documented type

fieldExternalTypeReference

protected String fieldExternalTypeReference(VariableElement field)

Extracts external type reference URL from Documented.Field present on a field

Returns:

reference url

fieldExternalTypeReference

protected String fieldExternalTypeReference(Documented.Field field)

k8TypeReference

protected Optional<String> k8TypeReference(String slug)

typeErasureReference

protected Optional<String> typeErasureReference(TypeMirror type)

typeArgumentReference

protected Optional<String> typeArgumentReference(TypeMirror type)

typeDescriptionBuilder

protected Documentation.TypeDescriptionBuilder typeDescriptionBuilder(String name)

Creates an appropriate instance of type description builder

Parameters:

name - type name

Returns:

type description builder

createFieldDocs

protected Documentation.FieldDescription createFieldDocs(Documented.Field field)

Called for each field documented by Documented.Field

Parameters:

field - field as Documented.Field

Returns:

field description

createFieldDocs

protected Documentation.FieldDescription createFieldDocs(VariableElement field)

Called for each field documented by JsonPropertyDescription

Parameters:

field - field as VariableElement

Returns:

filed description

formatter

protected abstract DocumentationFormatter formatter()

Creates an appropriate instance of documentation formatter

Returns:

documentation formatter