org.graalvm.compiler.options

Class OptionKey<T>

java.lang.Object

org.graalvm.compiler.options.OptionKey<T>

Direct Known Subclasses:

EnumOptionKey, NestedBooleanOptionKey

public class OptionKey<T>
extends Object

A key for an option. The value for an option is obtained from an OptionValues object.

Constructor Summary

Constructors

Constructor and Description
OptionKey(T defaultValue)

Method Summary

Modifier and Type	Method and Description
protected void	afterValueUpdate() Notifies this object after a value associated with this key was set or updated.
protected boolean	checkDescriptorExists() Checks that a descriptor exists for this key after triggering loading of descriptors.
T	getDefaultValue() The initial value specified in source code.
OptionDescriptor	getDescriptor() Returns the descriptor for this option, if it has been set by OptionKey.setDescriptor(OptionDescriptor).
String	getName() Gets the name of this option.
T	getValue(OptionValues values) Gets the value of this option in values.
T	getValueOrDefault(org.graalvm.collections.UnmodifiableEconomicMap<OptionKey<?>,Object> values) Gets the value of this option in values if it is present, otherwise OptionKey.getDefaultValue().
boolean	hasBeenSet(OptionValues values) Returns true if the option has been set in any way.
protected void	onValueUpdate(org.graalvm.collections.EconomicMap<OptionKey<?>,Object> values, T oldValue, T newValue) Notifies this object when a value associated with this key is set or updated in values.
void	putIfAbsent(org.graalvm.collections.EconomicMap<OptionKey<?>,Object> values, Object v) Sets the value of this option in a given map if it doesn't already have a value.
void	setDescriptor(OptionDescriptor descriptor) Sets the descriptor for this option.
String	toString()
void	update(org.graalvm.collections.EconomicMap<OptionKey<?>,Object> values, Object v) Sets the value of this option in a given map.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionKey

public OptionKey(T defaultValue)

Method Detail

setDescriptor

public final void setDescriptor(OptionDescriptor descriptor)

Sets the descriptor for this option.

getDescriptor

public final OptionDescriptor getDescriptor()

Returns the descriptor for this option, if it has been set by OptionKey.setDescriptor(OptionDescriptor).

checkDescriptorExists

protected boolean checkDescriptorExists()

Checks that a descriptor exists for this key after triggering loading of descriptors.

getName

public final String getName()

Gets the name of this option. The name for an option value with a null descriptor is the value of Object.toString().

toString

public String toString()

Overrides:

toString in class Object

getDefaultValue

public final T getDefaultValue()

The initial value specified in source code.

hasBeenSet

public boolean hasBeenSet(OptionValues values)

Returns true if the option has been set in any way. Note that this doesn't mean that the current value is different than the default.

getValue

public T getValue(OptionValues values)

Gets the value of this option in values.

getValueOrDefault

public T getValueOrDefault(org.graalvm.collections.UnmodifiableEconomicMap<OptionKey<?>,Object> values)

Gets the value of this option in values if it is present, otherwise OptionKey.getDefaultValue().

update

public void update(org.graalvm.collections.EconomicMap<OptionKey<?>,Object> values,
                   Object v)

Sets the value of this option in a given map. The OptionKey.onValueUpdate(EconomicMap, Object, Object) method is called once the value is set.

Parameters:

values - map of option values

v - the value to set for this key in values

putIfAbsent

public void putIfAbsent(org.graalvm.collections.EconomicMap<OptionKey<?>,Object> values,
                        Object v)

Sets the value of this option in a given map if it doesn't already have a value. The OptionKey.onValueUpdate(EconomicMap, Object, Object) method is called once the value is set.

Parameters:

values - map of option values

v - the value to set for this key in values

onValueUpdate

protected void onValueUpdate(org.graalvm.collections.EconomicMap<OptionKey<?>,Object> values,
                             T oldValue,
                             T newValue)

Notifies this object when a value associated with this key is set or updated in values.

Parameters:

values -

oldValue -

newValue -

afterValueUpdate

protected void afterValueUpdate()

Notifies this object after a value associated with this key was set or updated.