flexagon.ff.common.core.suggestions

Annotation Type SuggestionMethodMeta

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	depAlternate What should be used instead of deprecated field
boolean	deprecated
java.lang.String	description Markdown description of the method to show in suggestion help.
boolean	internalPublic Meant for public fields that meant to be internal and not exposed in UI Suggestions
java.lang.String[]	params Param names, in order.

Element Detail

description

public abstract java.lang.String description

Markdown description of the method to show in suggestion help.

Default:

""

params

public abstract java.lang.String[] params

Param names, in order.

Default:

{}

internalPublic

public abstract boolean internalPublic

Meant for public fields that meant to be internal and not exposed in UI Suggestions

Default:

false

deprecated

public abstract boolean deprecated

Default:

false

depAlternate

public abstract java.lang.String depAlternate

What should be used instead of deprecated field

Default:

""