org.springframework.boot.autoconfigure.condition

Annotation Type ConditionalOnProperty

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

Conditional that only matches when the specified properties are defined in Environment and not "false".

Since:

1.1.0

Author:

Maciej Walkowiak

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value One or more properties that must be present.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	prefix A prefix that should be applied to each property.
boolean	relaxedNames If relaxed names should be checked.

Element Detail

value

public abstract String[] value

One or more properties that must be present. If you are checking relaxed names you should specify the property in its dashed form.

Returns:

the property names

prefix

public abstract String prefix

A prefix that should be applied to each property.

Default:

""

relaxedNames

public abstract boolean relaxedNames

If relaxed names should be checked. Defaults to true.

Default:

true