Package org.apache.polaris.docs.generator

Class SmallRyeConfigPropertyInfo

java.lang.Object

org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo

All Implemented Interfaces:

PropertyInfo

public class SmallRyeConfigPropertyInfo
extends Object
implements PropertyInfo

Method Summary

Modifier and Type	Method	Description
String	defaultValue()
static String	defaultValue(io.smallrye.config.ConfigMappingInterface.Property property)
DocCommentTree	doc()
String	enumTooltipText()
static String	enumTooltipText(io.smallrye.config.ConfigMappingInterface.Property property)
Optional<Class<?>>	groupType()
boolean	isSettableType()
static boolean	isSettableType(io.smallrye.config.ConfigMappingInterface.Property property)
Optional<String>	prefixOverride()
Element	propertyElement()
String	propertyName()
String	propertySuffix()
boolean	sectionDocFromType()
String	simplifiedTypeName()
static String	simplifiedTypeName(io.smallrye.config.ConfigMappingInterface.Property property)
Optional<String>	unnamedKey()	Returns the unnamed key value if the property has WithUnnamedKey annotation.

Methods inherited from class java.lang.Object

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

Method Details

propertyElement

public Element propertyElement()

Specified by:

propertyElement in interface PropertyInfo

propertyName

public String propertyName()

Specified by:

propertyName in interface PropertyInfo

prefixOverride

public Optional<String> prefixOverride()

sectionDocFromType

public boolean sectionDocFromType()

propertySuffix

public String propertySuffix()

Specified by:

propertySuffix in interface PropertyInfo

unnamedKey

public Optional<String> unnamedKey()

Returns the unnamed key value if the property has WithUnnamedKey annotation. This indicates that the map property can be accessed without specifying a key name (using the default/unnamed key).

simplifiedTypeName

public String simplifiedTypeName()

Specified by:

simplifiedTypeName in interface PropertyInfo

enumTooltipText

public String enumTooltipText()

Specified by:

enumTooltipText in interface PropertyInfo

isSettableType

public boolean isSettableType()

groupType

public Optional<Class<?>> groupType()

Specified by:

groupType in interface PropertyInfo

isSettableType

public static boolean isSettableType(io.smallrye.config.ConfigMappingInterface.Property property)

simplifiedTypeName

public static String simplifiedTypeName(io.smallrye.config.ConfigMappingInterface.Property property)

enumTooltipText

public static String enumTooltipText(io.smallrye.config.ConfigMappingInterface.Property property)

doc

public DocCommentTree doc()

Specified by:

doc in interface PropertyInfo

defaultValue

public String defaultValue()

Specified by:

defaultValue in interface PropertyInfo

defaultValue

public static String defaultValue(io.smallrye.config.ConfigMappingInterface.Property property)