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

Class ConfigProperty

java.lang.Object

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

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

All Implemented Interfaces:

Comparable<AbstractConfigItem>

public final class ConfigProperty
extends AbstractConfigItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ConfigProperty.PropertyPath

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

ConfigProperty(ConfigPhase phase, String sourceType, String sourceElementName, SourceElementType sourceElementType, ConfigProperty.PropertyPath path, List<ConfigProperty.PropertyPath> additionalPaths, String type, String typeDescription, boolean map, boolean list, boolean optional, boolean secret, String mapKey, boolean unnamedMapKey, boolean withinMap, boolean converted, boolean isEnum, EnumAcceptedValues enumAcceptedValues, String defaultValue, boolean escapeDefaultValue, String javadocSiteLink, Deprecation deprecation)

Method Summary

Modifier and Type	Method	Description
int	compareTo(AbstractConfigItem o)
List<ConfigProperty.PropertyPath>	getAdditionalPaths()
String	getDefaultValue()
EnumAcceptedValues	getEnumAcceptedValues()
String	getEnvironmentVariable()	Deprecated.
String	getJavadocSiteLink()
String	getMapKey()
ConfigProperty.PropertyPath	getPath()
ConfigPhase	getPhase()
String	getTypeDescription()
boolean	hasDurationType()
boolean	hasMemorySizeType()
boolean	isConverted()
boolean	isEnum()
boolean	isEscapeDefaultValue()
boolean	isList()
boolean	isMap()
boolean	isOptional()
boolean	isSecret()
boolean	isSection()
boolean	isUnnamedMapKey()
boolean	isWithinMap()
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

Constructor Details

ConfigProperty

public ConfigProperty(ConfigPhase phase,
 String sourceType,
 String sourceElementName,
 SourceElementType sourceElementType,
 ConfigProperty.PropertyPath path,
 List<ConfigProperty.PropertyPath> additionalPaths,
 String type,
 String typeDescription,
 boolean map,
 boolean list,
 boolean optional,
 boolean secret,
 String mapKey,
 boolean unnamedMapKey,
 boolean withinMap,
 boolean converted,
 boolean isEnum,
 EnumAcceptedValues enumAcceptedValues,
 String defaultValue,
 boolean escapeDefaultValue,
 String javadocSiteLink,
 Deprecation deprecation)

Method Details

getPhase

public ConfigPhase getPhase()

getPath

public ConfigProperty.PropertyPath getPath()

Overrides:

getPath in class AbstractConfigItem

getAdditionalPaths

public List<ConfigProperty.PropertyPath> getAdditionalPaths()

getEnvironmentVariable

@Deprecated
public String getEnvironmentVariable()

Deprecated.

getTypeDescription

public String getTypeDescription()

isMap

public boolean isMap()

isList

public boolean isList()

isOptional

public boolean isOptional()

isSecret

public boolean isSecret()

getMapKey

public String getMapKey()

isUnnamedMapKey

public boolean isUnnamedMapKey()

isWithinMap

public boolean isWithinMap()

isConverted

public boolean isConverted()

isEnum

public boolean isEnum()

getEnumAcceptedValues

public EnumAcceptedValues getEnumAcceptedValues()

getDefaultValue

public String getDefaultValue()

isEscapeDefaultValue

public boolean isEscapeDefaultValue()

getJavadocSiteLink

public String getJavadocSiteLink()

isSection

public boolean isSection()

Specified by:

isSection in class AbstractConfigItem

compareTo

public int compareTo(AbstractConfigItem o)

hasDurationType

public boolean hasDurationType()

Specified by:

hasDurationType in class AbstractConfigItem

hasMemorySizeType

public boolean hasMemorySizeType()

Specified by:

hasMemorySizeType in class AbstractConfigItem

walk

protected void walk(ConfigItemVisitor visitor)

Specified by:

walk in class AbstractConfigItem