Vert.x 4.5.13 · io.vertx.core.cli.converters.ValueOfBasedConverter

public final Class ValueOfBasedConverter<T>

This 'default' converter tries to create objects using a static 'valueOf' method taking a single String argument. This converter is particularly convenient to for enumeration and primitive types.

Author

Clement Escoffier

Field Summary

Modifier and Type	Field and Description
private final Class<T>	clazz
private final Method	method
public static final String	VALUE_OF

Constructor Summary

Access	Constructor and Description
private	ValueOfBasedConverter(Class<T> clazz, Method method)

Method Summary

Modifier and Type	Method and Description
public T	Returns: the instance of T fromString(String the input, can be null input) Implements io.vertx.core.cli.converters.Converter.fromString. Converts the given input to an object by using the 'valueOf' method.
public static <T> ValueOfBasedConverter<T>	Returns: a `ValueOfBasedConverter` if the given class is eligible, null otherwise. getIfEligible(Class<T> the class clazz) Checks whether the given class can be used by the `ValueOfBasedConverter` (i.e. has a static 'valueOf' method taking a single String as argument).

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

Field Detail

clazz	back to summary
private final Class<T> clazz

method	back to summary
private final Method method

VALUE_OF	back to summary
public static final String VALUE_OF

Constructor Detail

ValueOfBasedConverter	back to summary
private ValueOfBasedConverter(Class<T> clazz, Method method)

Method Detail

fromString	back to summary
public T fromString(String input) throws IllegalArgumentException Implements io.vertx.core.cli.converters.Converter.fromString. Converts the given input to an object by using the 'valueOf' method. Notice that the method may receive a null value. Parameters input:String the input, can be null Returns:T the instance of T Annotations @Override Exceptions IllegalArgumentException: if the instance of T cannot be created from the input.

fromString

back to summary

public T fromString(String input) throws IllegalArgumentException

Implements io.vertx.core.cli.converters.Converter.fromString.

Converts the given input to an object by using the 'valueOf' method. Notice that the method may receive a null value.

Parameters

input:String: the input, can be null

Returns:T

the instance of T

Annotations

@Override

Exceptions

IllegalArgumentException:: if the instance of T cannot be created from the input.

getIfEligible back to summary

getIfEligible	back to summary
public static <T> ValueOfBasedConverter<T> getIfEligible(Class<T> clazz) Checks whether the given class can be used by the `ValueOfBasedConverter` (i.e. has a static 'valueOf' method taking a single String as argument). If so, creates a new instance of converter for this type. Parameters clazz:Class<T> the class Returns:ValueOfBasedConverter<T> a `ValueOfBasedConverter` if the given class is eligible, null otherwise. Annotations @SuppressWarnings:unchecked

public static <T> ValueOfBasedConverter<T> getIfEligible(Class<T> clazz)

Checks whether the given class can be used by the ValueOfBasedConverter (i.e. has a static 'valueOf' method taking a single String as argument). If so, creates a new instance of converter for this type.