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 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 and Description
ConfigDescriptionBuildItem(String propertyName, Class<?> type, String defaultValue, String docs)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ConfigDescriptionBuildItem o)
String	getDefaultValue()
String	getDocs()
String	getPropertyName()
Class<?>	getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDescriptionBuildItem

public ConfigDescriptionBuildItem(String propertyName,
                                  Class<?> type,
                                  String defaultValue,
                                  String docs)

Method Detail

getPropertyName

public String getPropertyName()

getType

public Class<?> getType()

getDefaultValue

public String getDefaultValue()

getDocs

public String getDocs()

compareTo

public int compareTo(ConfigDescriptionBuildItem o)

Specified by:

compareTo in interface Comparable<ConfigDescriptionBuildItem>