io.quarkus.arc.properties

Annotation Type IfBuildProperty

@Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE,FIELD})
public @interface IfBuildProperty

When applied to a bean class or producer method (or field), the bean will only be enabled if the Quarkus build time property matches the provided value.

By default, the bean is not enabled when the build time property is not defined at all, but this behavior is configurable via the {#code enableIfMissing} property.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Name of the build time property to check
String	stringValue Expected String value of the build time property (specified by name) if the bean is to be enabled

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	enableIfMissing Determines if the bean is to be enabled when the property name specified by name has not been specified at all

Element Detail

name

public abstract String name

Name of the build time property to check

stringValue

public abstract String stringValue

Expected String value of the build time property (specified by name) if the bean is to be enabled

enableIfMissing

public abstract boolean enableIfMissing

Determines if the bean is to be enabled when the property name specified by name has not been specified at all

Default:

false