joptsimple.util

Class PathConverter

java.lang.Object

joptsimple.util.PathConverter

All Implemented Interfaces:

ValueConverter<java.nio.file.Path>

public class PathConverter
extends java.lang.Object
implements ValueConverter<java.nio.file.Path>

Converts command line options to Path objects and checks the status of the underlying file.

Field Summary

Fields

Modifier and Type	Field and Description
private PathProperties[]	pathProperties

Constructor Summary

Constructors

Constructor and Description
PathConverter(PathProperties... pathProperties)

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	convert(java.lang.String value) Converts the given string value into a Java type.
private java.lang.String	message(java.lang.String errorKey, java.lang.String value)
java.lang.String	valuePattern() Gives a string that describes the pattern of the values this converter expects, if any.
java.lang.Class<java.nio.file.Path>	valueType() Gives the class of the type of values this converter converts to.

Methods inherited from class java.lang.Object

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

Field Detail

pathProperties

private final PathProperties[] pathProperties

Constructor Detail

PathConverter

public PathConverter(PathProperties... pathProperties)

Method Detail

convert

public java.nio.file.Path convert(java.lang.String value)

Description copied from interface: ValueConverter

Converts the given string value into a Java type.

Specified by:

convert in interface ValueConverter<java.nio.file.Path>

Parameters:

value - the string to convert

Returns:

the converted value

valueType

public java.lang.Class<java.nio.file.Path> valueType()

Description copied from interface: ValueConverter

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

Specified by:

valueType in interface ValueConverter<java.nio.file.Path>

Returns:

the target class for conversion

valuePattern

public java.lang.String valuePattern()

Description copied from interface: ValueConverter

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.

Specified by:

valuePattern in interface ValueConverter<java.nio.file.Path>

Returns:

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

message

private java.lang.String message(java.lang.String errorKey,
                                 java.lang.String value)