Graal Sdk 24.1.2 · org.graalvm.options.OptionType · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static interface	OptionType.Converter<T>

Modifier and Type	Field and Description
private final OptionType.Converter<T>	converter
private static final Map<Class<?>, OptionType<?>>	DEFAULTTYPES
private static final Consumer<?>	EMPTY_VALIDATOR
private final boolean	isDefaultType
private final boolean	isOptionMap
private final String	name
private final Consumer<T>	validator

Constructor Summary

Access	Constructor and Description
public	OptionType(String the name of the type. name, Function<String, T> a function that converts a string value to the option value. Can throw `IllegalArgumentException` to indicate an invalid string. stringConverter, Consumer<T> used for validating the option value. Throws `IllegalArgumentException` if the value is invalid. 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.
private	OptionType(String name, OptionType.Converter<T> converter, Consumer<T> validator, boolean isOptionMap, boolean isDefaultType)
private	OptionType(String name, Function<String, T> stringConverter, boolean isDefaultType)
public	OptionType(String the name of the type. name, Function<String, T> a function that converts a string value to the option value. Can throw `IllegalArgumentException` to indicate an invalid string. stringConverter) Constructs a new option type with name and function that allows to convert a string to the option type.
public	OptionType(String name, T defaultValue, Function<String, T> stringConverter, Consumer<T> validator) Deprecated since 19.0. Use `OptionType(String, Function, Consumer)`
public	OptionType(String name, T defaultValue, Function<String, T> stringConverter) Deprecated since 19.0. Use `OptionType(String, Function)`

Method Summary

Modifier and Type	Method and Description
public T	convert(String value) Converts a string value, validates it, and converts it to an object of this type.
public T	convert(Object the previous value holded by option. previousValue, String the key for prefix options. nameSuffix, String value) Converts a string value, validates it, and converts it to an object of this type.
private static <T> OptionType<T>	defaultEnumType(Class<T> clazz)
public static <T> OptionType<T>	defaultType(T value) Returns the default option type for a given value.
public static <T> OptionType<T>	defaultType(Class<T> clazz) Returns the default option type for a class.
public T	getDefaultValue() Deprecated since 19.0.
public String	getName() Returns the name of this type.
pack-priv boolean	isDefaultType()
pack-priv boolean	isOptionMap()
pack-priv static <V> OptionType<OptionMap<V>>	mapOf(Class<V> valueClass) Returns the default option type for option maps for the given value class.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validate(T value) Validates an option value and throws an `IllegalArgumentException` if the value is invalid.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

converter	back to summary
private final OptionType.Converter<T> converter

DEFAULTTYPES	back to summary
private static final Map<Class<?>, OptionType<?>> DEFAULTTYPES

EMPTY_VALIDATOR	back to summary
private static final Consumer<?> EMPTY_VALIDATOR

isDefaultType	back to summary
private final boolean isDefaultType

isOptionMap	back to summary
private final boolean isOptionMap

name	back to summary
private final String name

validator	back to summary
private final Consumer<T> validator

Constructor Detail

OptionType back to summary

OptionType	back to summary
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:String the name of the type. stringConverter:Function<String, T> a function that converts a string value to the option value. Can throw `IllegalArgumentException` to indicate an invalid string. validator:Consumer<T> used for validating the option value. Throws `IllegalArgumentException` if the value is invalid. Since 19.0

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:String: the name of the type.
stringConverter:Function<String, T>: a function that converts a string value to the option value. Can throw IllegalArgumentException to indicate an invalid string.
validator:Consumer<T>: used for validating the option value. Throws IllegalArgumentException if the value is invalid.

Since

19.0

OptionType	back to summary
private OptionType(String name, OptionType.Converter<T> converter, Consumer<T> validator, boolean isOptionMap, boolean isDefaultType)

OptionType	back to summary
private OptionType(String name, Function<String, T> stringConverter, boolean isDefaultType) Annotations @SuppressWarnings:unchecked

OptionType back to summary

OptionType	back to summary
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:String the name of the type. stringConverter:Function<String, T> a function that converts a string value to the option value. Can throw `IllegalArgumentException` to indicate an invalid string. Annotations @SuppressWarnings:unchecked Since 19.0

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:String: the name of the type.
stringConverter:Function<String, T>: a function that converts a string value to the option value. Can throw IllegalArgumentException to indicate an invalid string.

Annotations

@SuppressWarnings:unchecked

Since

19.0

OptionType	back to summary
public OptionType(String name, T defaultValue, Function<String, T> stringConverter, Consumer<T> validator) Deprecated since 19.0. Use `OptionType(String, Function, Consumer)` Annotations @Deprecated since:19.0 @SuppressWarnings:unused Since 19.0

OptionType	back to summary
public OptionType(String name, T defaultValue, Function<String, T> stringConverter) Deprecated since 19.0. Use `OptionType(String, Function)` Annotations @Deprecated since:19.0 @SuppressWarnings:unused Since 19.0

Method Detail

convert	back to summary
public T convert(String value) Converts a string value, validates it, and converts it to an object of this type. Exceptions IllegalArgumentException: if the value is invalid or cannot be converted. Since 19.0

convert

back to summary

public T convert(String value)

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

Exceptions

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

Since

19.0

convert	back to summary
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:Object the previous value holded by option. nameSuffix:String the key for prefix options. Annotations @SuppressWarnings:unchecked Exceptions IllegalArgumentException: if the value is invalid or cannot be converted. Since 19.2

convert

back to summary

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:Object: the previous value holded by option.
nameSuffix:String: the key for prefix options.

Annotations

@SuppressWarnings:unchecked

Exceptions

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

Since

19.2

defaultEnumType	back to summary
private static <T> OptionType<T> defaultEnumType(Class<T> clazz) Annotations @SuppressWarnings:unchecked

defaultType back to summary

defaultType	back to summary
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. Annotations @SuppressWarnings:unchecked Since 19.0

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.

Annotations

@SuppressWarnings:unchecked

Since

19.0

defaultType back to summary

defaultType	back to summary
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. Annotations @SuppressWarnings:unchecked Since 19.0

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.

Annotations

@SuppressWarnings:unchecked

Since

19.0

getDefaultValue	back to summary
public T getDefaultValue() Deprecated since 19.0. Annotations @Deprecated since:19.0 Since 19.0

getName	back to summary
public String getName() Returns the name of this type. Since 19.0

getName

back to summary

public String getName()

Returns the name of this type.

Since: 19.0

isDefaultType	back to summary
pack-priv boolean isDefaultType()

isOptionMap	back to summary
pack-priv boolean isOptionMap()

mapOf back to summary

mapOf	back to summary
pack-priv static <V> OptionType<OptionMap<V>> mapOf(Class<V> valueClass) Returns the default option type for option maps for the given value class. Returns `null` if no default option type is available for the value class. Annotations @SuppressWarnings:unchecked

pack-priv static <V> OptionType<OptionMap<V>> mapOf(Class<V> valueClass)

Returns the default option type for option maps for the given value class. Returns null if no default option type is available for the value class.

Annotations

@SuppressWarnings:unchecked

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override Since 19.0

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Since

19.0

validate back to summary

validate	back to summary
public void validate(T value) Validates an option value and throws an `IllegalArgumentException` if the value is invalid. Exceptions IllegalArgumentException: if the value is invalid or cannot be converted. Since 19.0

public void validate(T value)

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

Exceptions

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

Since

19.0

public final Class OptionType<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface OptionType.Converter<T>

Method Summary

Method Detail