Top Description Fields Methods
org.graalvm.options

public Interface OptionDescriptors

Additional top-level classes in compilation unit: OptionDescriptorsMap, UnionOptionDescriptors.

extends Iterable<OptionDescriptor>
Known Direct Implementers
org.graalvm.options.OptionDescriptorsMap, org.graalvm.options.UnionOptionDescriptors, org.graalvm.polyglot.impl.ModuleToUnnamedBridge.ModuleToUnnamedOptionDescriptors, org.graalvm.polyglot.impl.UnnamedToModuleBridge.UnnamedToModuleOptionDescriptors
Imports
java.util.ArrayList, .Arrays, .Collections, .Iterator, .LinkedHashMap, .List, .Map, .NoSuchElementException
An interface to a set of OptionDescriptors.
Since
19.0

Field Summary

Modifier and TypeField and Description
public static final OptionDescriptors
EMPTY

An empty set of option descriptors.

Method Summary

Modifier and TypeMethod and Description
public static OptionDescriptors
create(List<OptionDescriptor> descriptors)

Creates an OptionDescriptors instance from a list.

public static OptionDescriptors
createUnion(OptionDescriptors... descriptors)

Creates a union options descriptor out of multiple given descriptors.

public OptionDescriptor
get(String optionName)

Gets the OptionDescriptor matching a given option name or null if this option descriptor set does not contain a matching option name.

public Iterator<OptionDescriptor>
iterator()

Redeclares java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Inherited from java.lang.Iterable:
forEachspliterator

Field Detail

EMPTYback to summary
public static final OptionDescriptors EMPTY

An empty set of option descriptors.

Since
19.0

Method Detail

createback to summary
public static OptionDescriptors create(List<OptionDescriptor> descriptors)

Creates an OptionDescriptors instance from a list. The option descriptors implementation is backed by a LinkedHashMap that preserves ordering.

Since
19.0
createUnionback to summary
public static OptionDescriptors createUnion(OptionDescriptors... descriptors)

Creates a union options descriptor out of multiple given descriptors. The operation descriptors are not checked for duplicate keys. The option descriptors are iterated in declaration order.

Since
19.0
getback to summary
public OptionDescriptor get(String optionName)

Gets the OptionDescriptor matching a given option name or null if this option descriptor set does not contain a matching option name.

Since
19.0
iteratorback to summary
public Iterator<OptionDescriptor> iterator()

Redeclares java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<OptionDescriptor>

an Iterator.

Annotations
@Override
Since
19.0