com.oracle.svm.core.option

Annotation Type APIOption

@Repeatable(value=APIOption.List.class)
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface APIOption

If an Option is additionally annotated with APIOption it will be exposed as native-image option with the given name.

Field Summary

Fields

Modifier and Type	Fields and Description
static char	WHITESPACE_SEPARATOR

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	name The name of the option when exposed as native-image option.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	customHelp Provide a custom help message for the option.
String[]	defaultValue The value that will be passed to a non-boolean option when no = is specified.
String	deprecated
boolean	extra This option should only be shown with --help-extra.
String[]	fixedValue If a fixedValue is provided the APIOption will not accept custom option values and instead always use the specified value.
Class<? extends APIOptionGroup>	group Make a boolean option part of a group of boolean options.
APIOption.APIOptionKind	kind
char[]	valueSeparator Provide a custom separator that should be used to separate the option name from its option values.
Class<? extends Function<Object,Object>>[]	valueTransformer Allow transforming option values before assigning them to the underlying Option.

Field Detail

WHITESPACE_SEPARATOR

public static final char WHITESPACE_SEPARATOR

Element Detail

name

public abstract String[] name

The name of the option when exposed as native-image option. If more than one name is passed the other names are set up as aliases for the option.

extra

public abstract boolean extra

This option should only be shown with --help-extra.

Default:

false

group

public abstract Class<? extends APIOptionGroup> group

Make a boolean option part of a group of boolean options.

Default:

com.oracle.svm.core.option.APIOption.NullGroup.class

customHelp

public abstract String customHelp

Provide a custom help message for the option.

Default:

""

kind

public abstract APIOption.APIOptionKind kind

Default:

com.oracle.svm.core.option.APIOption.APIOptionKind.Default

valueSeparator

public abstract char[] valueSeparator

Provide a custom separator that should be used to separate the option name from its option values. The default separator is '='. If WHITESPACE_SEPARATOR is used the option value has to be passed as the next argument (i.e., separated by whitespace on the command line). It is also allowed to provide more than one separator. See e.g. the options defined in com.oracle.svm.hosted.NativeImageClassLoaderOptions

Default:

61

defaultValue

public abstract String[] defaultValue

The value that will be passed to a non-boolean option when no = is specified.

By default --option form is equivalent to --option= (it passes empty string).

Default:

{}

fixedValue

public abstract String[] fixedValue

If a fixedValue is provided the APIOption will not accept custom option values and instead always use the specified value.

Default:

{}

valueTransformer

public abstract Class<? extends Function<Object,Object>>[] valueTransformer

Allow transforming option values before assigning them to the underlying Option.

Default:

com.oracle.svm.core.option.APIOption.DefaultTransformer.class

deprecated

public abstract String deprecated

Default:

""