Class OptionDescriptor.Builder

java.lang.Object

org.graalvm.options.OptionDescriptor.Builder

Enclosing class:

OptionDescriptor

public final class OptionDescriptor.Builder
extends Object

Represents an option descriptor builder.

Since:

19.0

Method Summary

Modifier and Type	Method	Description
OptionDescriptor	build()	Builds and returns a new option descriptor.
OptionDescriptor.Builder	category(OptionCategory category)	Defines the user category for this option.
OptionDescriptor.Builder	constant(boolean value)	Marks this option as constant.
OptionDescriptor.Builder	deprecated(boolean deprecated)	Defines if this option is deprecated.
OptionDescriptor.Builder	deprecationMessage(String deprecationMessage)	Specifies a human-readable deprecation reason and the recommended fix.
OptionDescriptor.Builder	help(String help)	Specifies a human-readable description on how to use the option.
OptionDescriptor.Builder	stability(OptionStability stability)	Defines the stability of this option.
OptionDescriptor.Builder	usageSyntax(String usageSyntax)	Specifies a human-readable syntax describing the accepted values for this option.

Methods inherited from class Object

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

Method Details

category

public OptionDescriptor.Builder category(OptionCategory category)

Defines the user category for this option. The default value is OptionCategory.INTERNAL.

Since:

19.0

stability

public OptionDescriptor.Builder stability(OptionStability stability)

Defines the stability of this option. The default value is OptionStability.EXPERIMENTAL.

Since:

19.0

deprecated

public OptionDescriptor.Builder deprecated(boolean deprecated)

Defines if this option is deprecated. The default value for deprecated is false. This can be used to evolve options between releases.

Since:

19.0

help

public OptionDescriptor.Builder help(String help)

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

Since:

19.0

usageSyntax

public OptionDescriptor.Builder usageSyntax(String usageSyntax)

Specifies a human-readable syntax describing the accepted values for this option.

Since:

22.1

deprecationMessage

public OptionDescriptor.Builder deprecationMessage(String deprecationMessage)

Specifies a human-readable deprecation reason and the recommended fix.

Since:

20.1.0

constant

public OptionDescriptor.Builder constant(boolean value)

Marks this option as constant. Constant options use ConstantOptionKey as their key type and must be configured using the system property -Dpolyglot.<option-name>=<value> before the polyglot runtime is initialized. Setting a constant option at runtime via Engine.Builder.option(String, String) throws an IllegalArgumentException. The default value is false.

Since:

25.1

See Also:

• ConstantOptionKey

build

public OptionDescriptor build()

Builds and returns a new option descriptor.

Throws:

IllegalArgumentException - if this descriptor is marked with constant(true) but the key is not a ConstantOptionKey, or if the key is a ConstantOptionKey but the descriptor is not marked with constant(true).

Since:

19.0