Package io.debezium.operator.docs.model

Class Documentation

java.lang.Object

io.debezium.operator.docs.model.Documentation

public final class Documentation
extends Object

Abstract representation of CR reference documentation. Documentation is represented as a collection of documented types see Documentation.TypeDescription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Documentation.FieldDescription
static final record	Documentation.TypeDescription	Documentation of a type
static class	Documentation.TypeDescriptionBuilder	Builder for Documentation.TypeDescription

Field Summary

Fields

Modifier and Type	Field	Description
private final String	title
private final Set<String>	typeNames
private final List<Documentation.TypeDescription>	types
private Map<String,Set<String>>	usageReference

Constructor Summary

Constructors

Constructor	Description
Documentation(String title)	Creates new documentation

Method Summary

Modifier and Type	Method	Description
Documentation	addTypeDescription(Documentation.TypeDescription type)
Set<String>	getUsages(String name)
boolean	isKnownType(String name)
String	title()
Set<String>	typeNames()
List<Documentation.TypeDescription>	types()

Methods inherited from class java.lang.Object

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

Field Details

title

private final String title

types

private final List<Documentation.TypeDescription> types

typeNames

private final Set<String> typeNames

usageReference

private Map<String,Set<String>> usageReference

Constructor Details

Documentation

public Documentation(String title)

Creates new documentation

Parameters:

title - title of this Documentation

Method Details

addTypeDescription

public Documentation addTypeDescription(Documentation.TypeDescription type)

title

public String title()

types

public List<Documentation.TypeDescription> types()

typeNames

public Set<String> typeNames()

isKnownType

public boolean isKnownType(String name)

getUsages

public Set<String> getUsages(String name)