com.oracle.svm.core.option

Class RuntimeOptionParser

java.lang.Object

com.oracle.svm.core.option.RuntimeOptionParser

public final class RuntimeOptionParser
extends Object

Option parser to be used by an application that runs on Substrate VM. The list of options that are available is collected during native image generation. There is no requirement to use this class, you can also implement your own option parsing and then set the values of options manually.

Constructor Summary

Constructors

Constructor and Description
RuntimeOptionParser()

Method Summary

Modifier and Type	Method and Description
Optional<org.graalvm.compiler.options.OptionDescriptor>	getDescriptor(String optionName)
Collection<org.graalvm.compiler.options.OptionDescriptor>	getDescriptors()
org.graalvm.compiler.options.OptionKey<?>	lookupOption(String name, Collection<org.graalvm.compiler.options.OptionDescriptor> fuzzyMatches)
String[]	parse(String[] args, String optionPrefix) Parses args and sets/updates runtime option values for the elements matching a runtime option.
String[]	parse(String[] args, String optionPrefix, SubstrateOptionsParser.BooleanOptionFormat booleanOptionFormat, boolean systemExitOnError) Parses args and sets/updates runtime option values for the elements matching a runtime option.
static String[]	parseAndConsumeAllOptions(String[] initialArgs) Parse and consume all standard options and system properties supported by Substrate VM.
static RuntimeOptionParser	singleton() Returns the singleton instance that is created during native image generation and stored in the ImageSingletons.
boolean	updateRuntimeOptions(Set<org.graalvm.compiler.options.OptionDescriptor> newRuntimeOptions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuntimeOptionParser

public RuntimeOptionParser()

Method Detail

parseAndConsumeAllOptions

public static String[] parseAndConsumeAllOptions(String[] initialArgs)

Parse and consume all standard options and system properties supported by Substrate VM. The returned array contains all arguments that were not consumed, i.e., were not recognized as options.

getDescriptor

public Optional<org.graalvm.compiler.options.OptionDescriptor> getDescriptor(String optionName)

updateRuntimeOptions

public boolean updateRuntimeOptions(Set<org.graalvm.compiler.options.OptionDescriptor> newRuntimeOptions)

singleton

public static RuntimeOptionParser singleton()

Returns the singleton instance that is created during native image generation and stored in the ImageSingletons.

parse

public String[] parse(String[] args,
                      String optionPrefix)

Parses args and sets/updates runtime option values for the elements matching a runtime option. Arguments for boolean options are expected to be in SubstrateOptionsParser.BooleanOptionFormat.PLUS_MINUS format.

Parameters:

args - arguments to be parsed

optionPrefix - prefix for the options

Returns:

elements in args that do not match any runtime options

Throws:

IllegalArgumentException - if an element in args matches a runtime option but has an invalid format. The parse error is described by Throwable.getMessage().

parse

public String[] parse(String[] args,
                      String optionPrefix,
                      SubstrateOptionsParser.BooleanOptionFormat booleanOptionFormat,
                      boolean systemExitOnError)

Parses args and sets/updates runtime option values for the elements matching a runtime option.

Parameters:

args - arguments to be parsed

optionPrefix - prefix for the options

systemExitOnError - determines whether to call System.exit(int) if any element in args matches a runtime option but has an invalid format

Returns:

elements in args that do not match any runtime options

Throws:

IllegalArgumentException - if an element in args is invalid and systemExitOnError == false. The parse error is described by Throwable.getMessage().

lookupOption

public org.graalvm.compiler.options.OptionKey<?> lookupOption(String name,
                                                              Collection<org.graalvm.compiler.options.OptionDescriptor> fuzzyMatches)

getDescriptors

public Collection<org.graalvm.compiler.options.OptionDescriptor> getDescriptors()