org.graalvm.compiler.options

Annotation Type Option

@Retention(value=SOURCE)
 @Target(value=FIELD)
public @interface Option

Describes the attributes of an option whose value is in a static field annotated by this annotation type.

See Also:

OptionDescriptor

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	help Gets a help message for the option.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deprecated Deprecated option.
String	deprecationMessage The deprecation reason and the recommended replacement.
String	name The name of the option.
OptionStability	stability Specifies the stability of the option.
OptionType	type Specifies the type of the option.

Element Detail

help

public abstract String[] help

Gets a help message for the option.

The first element of the array is the short help message. This part of the help message is subject to line wrapping when printed.

The remaining elements contain a more detailed expansion of the help message and will be printed as is in a left-aligned block (i.e. leading spaces will be preserved).

If there is only one element and it starts with "file:"<path>, then the help message is located in a file located by resolving <path> against the location of the package in which the option is declared. The first line in the file is the short help message as described above. The remaining lines are the help message expansion.

name

public abstract String name

The name of the option. By default, the name of the annotated field should be used.

Default:

""

type

public abstract OptionType type

Specifies the type of the option.

Default:

org.graalvm.compiler.options.OptionType.Debug

stability

public abstract OptionStability stability

Specifies the stability of the option.

Default:

org.graalvm.compiler.options.OptionStability.EXPERIMENTAL

deprecated

public abstract boolean deprecated

Deprecated option.

Default:

false

deprecationMessage

public abstract String deprecationMessage

The deprecation reason and the recommended replacement.

Default:

""