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.

Field Summary

Fields

Modifier and Type	Field and Description
org.graalvm.collections.EconomicMap<String,org.graalvm.compiler.options.OptionDescriptor>	options All reachable options.

Constructor Summary

Constructors

Constructor and Description
RuntimeOptionParser()

Method Summary

Modifier and Type	Method and Description
void	addDescriptor(org.graalvm.compiler.options.OptionDescriptor optionDescriptor)
Optional<org.graalvm.compiler.options.OptionDescriptor>	getDescriptor(String optionName)
Iterable<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 normalOptionPrefix, String graalOptionPrefix, String xOptionPrefix, boolean systemExitOnError, boolean ignoreUnrecognized) Parses args and sets/updates runtime option values for the elements matching a runtime option.
static String[]	parseAndConsumeAllOptions(String[] initialArgs, boolean ignoreUnrecognized) 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.

Methods inherited from class java.lang.Object

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

Field Detail

options

public org.graalvm.collections.EconomicMap<String,org.graalvm.compiler.options.OptionDescriptor> options

All reachable options.

Constructor Detail

RuntimeOptionParser

public RuntimeOptionParser()

Method Detail

parseAndConsumeAllOptions

public static String[] parseAndConsumeAllOptions(String[] initialArgs,
                                                 boolean ignoreUnrecognized)

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.

addDescriptor

public void addDescriptor(org.graalvm.compiler.options.OptionDescriptor optionDescriptor)

getDescriptor

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

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 normalOptionPrefix,
                      String graalOptionPrefix,
                      String xOptionPrefix,
                      boolean systemExitOnError,
                      boolean ignoreUnrecognized)

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

Parameters:

args - arguments to be parsed

normalOptionPrefix - prefix for normal Native Image runtime options

graalOptionPrefix - prefix for Graal-style options

xOptionPrefix - prefix for X-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 Iterable<org.graalvm.compiler.options.OptionDescriptor> getDescriptors()