Class OptionType<T>

java.lang.Object

org.graalvm.options.OptionType<T>

public final class OptionType<T>
extends Object

Represents a type of an option that allows to convert string values to Java values.

Since:

19.0

Constructor Summary

Constructors

Constructor	Description
OptionType(String name, Function<String,T> stringConverter)	Constructs a new option type with name and function that allows to convert a string to the option type.
OptionType(String name, Function<String,T> stringConverter, Consumer<T> validator)	Constructs a new option type with name and function that allows to convert a string to the option type and validator of the option values.
OptionType(String name, T defaultValue, Function<String,T> stringConverter)	Deprecated. Use OptionType(String, Function)
OptionType(String name, T defaultValue, Function<String,T> stringConverter, Consumer<T> validator)	Deprecated. Use OptionType(String, Function, Consumer)

Method Summary

Modifier and Type	Method	Description
T	convert(Object previousValue, String nameSuffix, String value)	Converts a string value, validates it, and converts it to an object of this type.
T	convert(String value)	Converts a string value, validates it, and converts it to an object of this type.
static <T> OptionType<T>	defaultType(Class<T> clazz)	Returns the default option type for a class.
static <T> OptionType<T>	defaultType(T value)	Returns the default option type for a given value.
T	getDefaultValue()	Deprecated.
String	getName()	Returns the name of this type.
String	toString()
void	validate(T value)	Validates an option value and throws an IllegalArgumentException if the value is invalid.

Methods inherited from class Object

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

Constructor Details

OptionType

public OptionType(String name,
 Function<String,T> stringConverter,
 Consumer<T> validator)

Constructs a new option type with name and function that allows to convert a string to the option type and validator of the option values.

Parameters:

name - the name of the type.

stringConverter - a function that converts a string value to the option value. Can throw IllegalArgumentException to indicate an invalid string.

validator - used for validating the option value. Throws IllegalArgumentException if the value is invalid.

Since:

19.0

OptionType

public OptionType(String name,
 Function<String,T> stringConverter)

Constructs a new option type with name and function that allows to convert a string to the option type.

Parameters:

name - the name of the type.

stringConverter - a function that converts a string value to the option value. Can throw IllegalArgumentException to indicate an invalid string.

Since:

19.0

OptionType

@Deprecated(since="19.0")
public OptionType(String name,
 T defaultValue,
 Function<String,T> stringConverter,
 Consumer<T> validator)

Deprecated.

Use OptionType(String, Function, Consumer)

Since:

19.0

OptionType

@Deprecated(since="19.0")
public OptionType(String name,
 T defaultValue,
 Function<String,T> stringConverter)

Deprecated.

Use OptionType(String, Function)

Since:

19.0

Method Details

getDefaultValue

@Deprecated(since="19.0")
public T getDefaultValue()

Deprecated.

Since:

19.0

getName

public String getName()

Returns the name of this type.

Since:

19.0

convert

public T convert(String value)

Converts a string value, validates it, and converts it to an object of this type.

Throws:

IllegalArgumentException - if the value is invalid or cannot be converted.

Since:

19.0

convert

public T convert(Object previousValue,
 String nameSuffix,
 String value)

Converts a string value, validates it, and converts it to an object of this type. For option maps includes the previous map stored for the option and the key.

Parameters:

previousValue - the previous value holded by option.

nameSuffix - the key for prefix options.

Throws:

IllegalArgumentException - if the value is invalid or cannot be converted.

Since:

19.2

validate

public void validate(T value)

Validates an option value and throws an IllegalArgumentException if the value is invalid.

Throws:

IllegalArgumentException - if the value is invalid or cannot be converted.

Since:

19.0

toString

public String toString()

Overrides:

toString in class Object

Since:

19.0

defaultType

public static <T> OptionType<T> defaultType(T value)

Returns the default option type for a given value. Returns null if no default option type is available for the Java type of this value.

Since:

19.0

defaultType

public static <T> OptionType<T> defaultType(Class<T> clazz)

Returns the default option type for a class. Returns null if no default option type is available for this Java type.

Since:

19.0