Package io.quarkus.annotation.processor.documentation.config.model

Class ConfigSection

java.lang.Object

io.quarkus.annotation.processor.documentation.config.model.AbstractConfigItem

io.quarkus.annotation.processor.documentation.config.model.ConfigSection

All Implemented Interfaces:

ConfigItemCollection, Comparable<AbstractConfigItem>

public final class ConfigSection
extends AbstractConfigItem
implements ConfigItemCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ConfigSection.SectionPath

Nested classes/interfaces inherited from class io.quarkus.annotation.processor.documentation.config.model.AbstractConfigItem

AbstractConfigItem.Path

Field Summary

Fields inherited from class io.quarkus.annotation.processor.documentation.config.model.AbstractConfigItem

deprecation, path, sourceElementName, sourceElementType, sourceType, type

Constructor Summary

Constructors

Constructor	Description
ConfigSection(String sourceType, String sourceElementName, SourceElementType sourceElementType, ConfigSection.SectionPath path, String type, int level, boolean generated, Deprecation deprecation)

Method Summary

Modifier and Type	Method	Description
void	addItem(AbstractConfigItem item)
void	appendState(boolean generated, Deprecation deprecation)	This is used when we merge ConfigSection at the ConfigRoot level.
int	compareTo(AbstractConfigItem o)
List<AbstractConfigItem>	getItems()
int	getLevel()
ConfigSection.SectionPath	getPath()
boolean	hasDurationType()
boolean	hasMemorySizeType()
boolean	isGenerated()
boolean	isSection()
void	merge(ConfigSection other, Map<String,ConfigSection> existingConfigSections)	This is used to merge ConfigRoot when generating the AsciiDoc output.
protected void	walk(ConfigItemVisitor visitor)

Methods inherited from class io.quarkus.annotation.processor.documentation.config.model.AbstractConfigItem

getDeprecation, getPath$$bridge, getSourceElementName, getSourceElementType, getSourceType, getType, isDeprecated

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.annotation.processor.documentation.config.model.ConfigItemCollection

getNonDeprecatedItems, getNonDeprecatedProperties, getNonDeprecatedSections, getProperties, getSections

Constructor Details

ConfigSection

public ConfigSection(String sourceType,
 String sourceElementName,
 SourceElementType sourceElementType,
 ConfigSection.SectionPath path,
 String type,
 int level,
 boolean generated,
 Deprecation deprecation)

Method Details

addItem

public void addItem(AbstractConfigItem item)

Specified by:

addItem in interface ConfigItemCollection

getItems

public List<AbstractConfigItem> getItems()

Specified by:

getItems in interface ConfigItemCollection

compareTo

public int compareTo(AbstractConfigItem o)

Specified by:

compareTo in interface Comparable<AbstractConfigItem>

getPath

public ConfigSection.SectionPath getPath()

Overrides:

getPath in class AbstractConfigItem

isSection

public boolean isSection()

Specified by:

isSection in class AbstractConfigItem

isGenerated

public boolean isGenerated()

getLevel

public int getLevel()

appendState

public void appendState(boolean generated,
 Deprecation deprecation)

This is used when we merge ConfigSection at the ConfigRoot level. It can happen when for instance a path is both used at a given level and in an unnamed map. For instance in: HibernateOrmConfig.

merge

public void merge(ConfigSection other,
 Map<String,ConfigSection> existingConfigSections)

This is used to merge ConfigRoot when generating the AsciiDoc output.

hasDurationType

public boolean hasDurationType()

Specified by:

hasDurationType in interface ConfigItemCollection

Specified by:

hasDurationType in class AbstractConfigItem

hasMemorySizeType

public boolean hasMemorySizeType()

Specified by:

hasMemorySizeType in interface ConfigItemCollection

Specified by:

hasMemorySizeType in class AbstractConfigItem

walk

protected void walk(ConfigItemVisitor visitor)

Specified by:

walk in class AbstractConfigItem