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.

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
String[]	fixedValue If a fixedValue is provided the APIOption will not accept custom option values and instead always use the specified value.
APIOption.APIOptionKind	kind
Class<? extends Function<Object,Object>>[]	valueTransformer Allow transforming option values before assigning them to the underlying Option.

Element Detail

name

public abstract String name

The name of the option when exposed as native-image option.

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

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:

""