org.graalvm.compiler.options

Class OptionDescriptor

java.lang.Object

org.graalvm.compiler.options.OptionDescriptor

public final class OptionDescriptor
extends Object

Describes the attributes of a static field option and provides access to its value.

Method Summary

Modifier and Type	Method and Description
static OptionDescriptor	create(String name, OptionType optionType, Class<?> optionValueType, String help, Class<?> declaringClass, String fieldName, OptionKey<?> option)
static OptionDescriptor	create(String name, OptionType optionType, Class<?> optionValueType, String help, Class<?> declaringClass, String fieldName, OptionKey<?> option, boolean deprecated, String deprecationMessage)
static OptionDescriptor	create(String name, OptionType optionType, Class<?> optionValueType, String help, String[] extraHelp, Class<?> declaringClass, String fieldName, OptionKey<?> option)
static OptionDescriptor	create(String name, OptionType optionType, Class<?> optionValueType, String help, String[] extraHelp, Class<?> declaringClass, String fieldName, OptionKey<?> option, boolean deprecated, String deprecationMessage)
Class<?>	getDeclaringClass()
String	getDeprecationMessage() Returns the deprecation reason and the recommended replacement.
List<String>	getExtraHelp() Gets extra lines of help text.
String	getFieldName()
String	getHelp() Gets a descriptive help message for the option.
String	getLocation() Gets a description of the location where this option is stored.
String	getName() Gets the name of the option.
OptionKey<?>	getOptionKey() Gets the boxed option value.
OptionType	getOptionType() Gets the type of the option.
Class<?>	getOptionValueType() Gets the type of values stored in the option.
boolean	isDeprecated() Returns true if the option is deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OptionDescriptor create(String name,
                                      OptionType optionType,
                                      Class<?> optionValueType,
                                      String help,
                                      Class<?> declaringClass,
                                      String fieldName,
                                      OptionKey<?> option)

create

public static OptionDescriptor create(String name,
                                      OptionType optionType,
                                      Class<?> optionValueType,
                                      String help,
                                      Class<?> declaringClass,
                                      String fieldName,
                                      OptionKey<?> option,
                                      boolean deprecated,
                                      String deprecationMessage)

create

public static OptionDescriptor create(String name,
                                      OptionType optionType,
                                      Class<?> optionValueType,
                                      String help,
                                      String[] extraHelp,
                                      Class<?> declaringClass,
                                      String fieldName,
                                      OptionKey<?> option)

create

public static OptionDescriptor create(String name,
                                      OptionType optionType,
                                      Class<?> optionValueType,
                                      String help,
                                      String[] extraHelp,
                                      Class<?> declaringClass,
                                      String fieldName,
                                      OptionKey<?> option,
                                      boolean deprecated,
                                      String deprecationMessage)

getOptionValueType

public Class<?> getOptionValueType()

Gets the type of values stored in the option. This will be the boxed type for a primitive option.

getHelp

public String getHelp()

Gets a descriptive help message for the option. This message should be self contained without relying on extra help lines.

See Also:

Option.help()

getExtraHelp

public List<String> getExtraHelp()

Gets extra lines of help text. These lines should not be subject to any line wrapping or formatting apart from indentation.

getName

public String getName()

Gets the name of the option. It's up to the client of this object how to use the name to get a user specified value for the option from the environment.

getOptionType

public OptionType getOptionType()

Gets the type of the option.

getOptionKey

public OptionKey<?> getOptionKey()

Gets the boxed option value.

getDeclaringClass

public Class<?> getDeclaringClass()

getFieldName

public String getFieldName()

getLocation

public String getLocation()

Gets a description of the location where this option is stored.

isDeprecated

public boolean isDeprecated()

Returns true if the option is deprecated.

getDeprecationMessage

public String getDeprecationMessage()

Returns the deprecation reason and the recommended replacement.