jdk.internal.jvmci.options

Class OptionDescriptor

java.lang.Object

jdk.internal.jvmci.options.OptionDescriptor

public class OptionDescriptor
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	declaringClass
protected String	fieldName
protected String	help
protected String	name
protected OptionValue<?>	option
protected Class<?>	type

Constructor Summary

Constructors

Constructor and Description
OptionDescriptor(String name, Class<?> type, String help, Class<?> declaringClass, String fieldName, OptionValue<?> option)

Method Summary

Modifier and Type	Method and Description
Class<?>	getDeclaringClass()
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.
OptionValue<?>	getOptionValue() Gets the boxed option value.
Class<?>	getType() Gets the type of values stored in the option.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

type

protected final Class<?> type

help

protected final String help

option

protected final OptionValue<?> option

declaringClass

protected final Class<?> declaringClass

fieldName

protected final String fieldName

Constructor Detail

OptionDescriptor

public OptionDescriptor(String name,
                        Class<?> type,
                        String help,
                        Class<?> declaringClass,
                        String fieldName,
                        OptionValue<?> option)

Method Detail

getType

public Class<?> getType()

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.

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.

getOptionValue

public OptionValue<?> getOptionValue()

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.