org.springframework.xd.module.options.spi

Annotation Type ModuleOption

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ModuleOption

Used to annotate the setter methods of a POJO Module Options class to provide the framework with additional option information.

Author:

Eric Bottard

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value Provide a short description of the option.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	defaultValue Provide a default value representation of the option.
boolean	hidden Whether this option is considered "expert" or "infrastructure" and should typically not be presented to user.

Element Detail

value

public abstract java.lang.String value

Provide a short description of the option.

defaultValue

public abstract java.lang.String defaultValue

Provide a default value representation of the option. Only needed when there is no corresponding getter for that option that would return the default from a newly created instance.

Default:

"__NULL__"

hidden

public abstract boolean hidden

Whether this option is considered "expert" or "infrastructure" and should typically not be presented to user.

Default:

false