joptsimple

Interface ValueConverter<V>

Type Parameters:

V - constraint on the type of values being converted to

All Known Implementing Classes:

DateConverter, EnumConverter, InetAddressConverter, PathConverter, RegexMatcher

public interface ValueConverter<V>

Instances of this interface are used to convert arguments of options into specific Java types.

Author:

Paul Holser

Method Summary

Modifier and Type	Method and Description
V	convert(String value) Converts the given string value into a Java type.
default String	revert(Object value) Reverts a value to a string representation.
String	valuePattern() Gives a string that describes the pattern of the values this converter expects, if any.
Class<? extends V>	valueType() Gives the class of the type of values this converter converts to.

Method Detail

convert

V convert(String value)

Converts the given string value into a Java type.

Parameters:

value - the string to convert

Returns:

the converted value

Throws:

ValueConversionException - if a problem occurs while converting the value

revert

default String revert(Object value)

Reverts a value to a string representation.

It is not strictly required that revert(convert(v)).equals(v), but it is recommended.

Parameters:

value - a value

Returns:

a string representation of the value

valueType

Class<? extends V> valueType()

Gives the class of the type of values this converter converts to.

Returns:

the target class for conversion

valuePattern

String valuePattern()

Gives a string that describes the pattern of the values this converter expects, if any. For example, a date converter can respond with a date format string.

Returns:

a value pattern, or null if there's nothing interesting here