Package io.quarkus.deployment.builditem

Class ConfigDescriptionBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.deployment.builditem.ConfigDescriptionBuildItem

All Implemented Interfaces:

Comparable<ConfigDescriptionBuildItem>

public final class ConfigDescriptionBuildItem
extends io.quarkus.builder.item.MultiBuildItem
implements Comparable<ConfigDescriptionBuildItem>

A build item that is not part of the standard build, but is only used to generate example config files and docs.

Constructor Summary

Constructors

Constructor	Description
ConfigDescriptionBuildItem(String propertyName, String defaultValue, String docs, String valueTypeName, List<String> allowedValues, io.quarkus.runtime.annotations.ConfigPhase configPhase)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ConfigDescriptionBuildItem o)
List<String>	getAllowedValues()
io.quarkus.runtime.annotations.ConfigPhase	getConfigPhase()
String	getDefaultValue()
String	getDocs()
String	getPropertyName()
String	getValueTypeName()
boolean	hasAllowedValues()

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigDescriptionBuildItem

public ConfigDescriptionBuildItem(String propertyName,
 String defaultValue,
 String docs,
 String valueTypeName,
 List<String> allowedValues,
 io.quarkus.runtime.annotations.ConfigPhase configPhase)

Method Details

getPropertyName

public String getPropertyName()

getDefaultValue

public String getDefaultValue()

getDocs

public String getDocs()

getValueTypeName

public String getValueTypeName()

getAllowedValues

public List<String> getAllowedValues()

getConfigPhase

public io.quarkus.runtime.annotations.ConfigPhase getConfigPhase()

hasAllowedValues

public boolean hasAllowedValues()

compareTo

public int compareTo(ConfigDescriptionBuildItem o)

Specified by:

compareTo in interface Comparable<ConfigDescriptionBuildItem>