Top Description Inners Constructors Methods
org.graalvm.nativeimage

public final Class RuntimeOptions

extends Object
Class Inheritance
Imports
java.util.List, org.graalvm.nativeimage.impl.RuntimeOptionsSupport
Used for manipulating options at run time.
Since
19.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
RuntimeOptions.Descriptor

Constructor Summary

AccessConstructor and Description
private
RuntimeOptions()

Method Summary

Modifier and TypeMethod and Description
public static <T> T
get(String optionName)

Get the value of the option with the provided name.

public static RuntimeOptions.Descriptor
getDescriptor(String optionName)

Looks up a single descriptor given an option name.

public static List<RuntimeOptions.Descriptor>
listDescriptors()

Lists all runtime option descriptors available.

public static void
set(String optionName, Object value)

Set the value of the option with the provided name to the new value.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

RuntimeOptionsback to summary
private RuntimeOptions()

Method Detail

getback to summary
public static <T> T get(String optionName)

Get the value of the option with the provided name.

Since
19.0
getDescriptorback to summary
public static RuntimeOptions.Descriptor getDescriptor(String optionName)

Looks up a single descriptor given an option name. Returns null if no descriptor could be found.

Since
23.1
listDescriptorsback to summary
public static List<RuntimeOptions.Descriptor> listDescriptors()

Lists all runtime option descriptors available.

Since
23.1
setback to summary
public static void set(String optionName, Object value)

Set the value of the option with the provided name to the new value.

Since
19.0
org.graalvm.nativeimage back to summary

public Interface RuntimeOptions.Descriptor

Method Summary

Modifier and TypeMethod and Description
public Object
convertValue(String value)

Converts a string value, validates it, and converts it to an object of this type.

public Object
defaultValue()

Returns the default value of type valueType() for this option.

public boolean
deprecated()

Returns true if this option was marked deprecated.

public String
deprecatedMessage()

Returns the deprecation reason and the recommended fix.

public String
help()

Returns a human-readable description on how to use the option.

public String
name()

Returns the name of the option that this descriptor represents.

public Class<?>
valueType()

Returns the option type of this key.

Method Detail

convertValueback to summary
public Object convertValue(String value) throws IllegalArgumentException

Converts a string value, validates it, and converts it to an object of this type. For option maps includes the previous map stored for the option and the key.

Exceptions
IllegalArgumentException:
if the value is invalid or cannot be converted.
Since
23.1
defaultValueback to summary
public Object defaultValue()

Returns the default value of type valueType() for this option.

Since
23.1
deprecatedback to summary
public boolean deprecated()

Returns true if this option was marked deprecated. This indicates that the option is going to be removed in a future release or its use is not recommended.

Since
23.1
deprecatedMessageback to summary
public String deprecatedMessage()

Returns the deprecation reason and the recommended fix. For newlines, use %n.

Since
23.1
helpback to summary
public String help()

Returns a human-readable description on how to use the option. For newlines, use %n.

Since
23.1
nameback to summary
public String name()

Returns the name of the option that this descriptor represents.

Since
23.1
valueTypeback to summary
public Class<?> valueType()

Returns the option type of this key. Typical values are String, Boolean, Integer. The result of convertValue(String) is guaranteed to be assignable to this type.

Since
23.1