Package io.quarkus.docs.generation

Class YamlMetadataGenerator.DocMetadata

java.lang.Object

io.quarkus.docs.generation.YamlMetadataGenerator.DocMetadata

All Implemented Interfaces:

Comparable<YamlMetadataGenerator.DocMetadata>

Enclosing class:

YamlMetadataGenerator

static class YamlMetadataGenerator.DocMetadata
extends Object
implements Comparable<YamlMetadataGenerator.DocMetadata>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Set<YamlMetadataGenerator.Category>	categories
(package private) Set<String>	extensions
(package private) String	filename
(package private) String	id
(package private) Set<String>	keywords
(package private) String	summary
(package private) String	title
(package private) Set<String>	topics
(package private) YamlMetadataGenerator.Type	type

Constructor Summary

Constructors

Constructor	Description
DocMetadata(String title, Path path, String summary, Object categories, Object keywords, Object topics, Object extensions, Object diataxisType, String id)

Method Summary

Modifier and Type	Method	Description
int	compareTo(YamlMetadataGenerator.DocMetadata that)
String	getCategories()
Set<String>	getExtensions()
String	getFilename()
String	getId()
String	getKeywords()
String	getSummary()
String	getTitle()
Set<String>	getTopics()
String	getType()
String	getUrl()
Set<String>	toSet(Object value)

Methods inherited from class java.lang.Object

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

Field Details

title

String title

filename

String filename

summary

String summary

keywords

Set<String> keywords

categories

Set<YamlMetadataGenerator.Category> categories

topics

Set<String> topics

extensions

Set<String> extensions

id

String id

type

YamlMetadataGenerator.Type type

Constructor Details

DocMetadata

DocMetadata(String title,
 Path path,
 String summary,
 Object categories,
 Object keywords,
 Object topics,
 Object extensions,
 Object diataxisType,
 String id)

Method Details

getId

public String getId()

getFilename

public String getFilename()

getTitle

public String getTitle()

getSummary

public String getSummary()

getUrl

public String getUrl()

getCategories

public String getCategories()

toSet

public Set<String> toSet(Object value)

getKeywords

public String getKeywords()

getExtensions

public Set<String> getExtensions()

getTopics

public Set<String> getTopics()

getType

public String getType()

compareTo

public int compareTo(YamlMetadataGenerator.DocMetadata that)

Specified by:

compareTo in interface Comparable<YamlMetadataGenerator.DocMetadata>