clikt / com.github.ajalt.clikt.parameters.types / path

path

fun RawArgument.path(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false, fileSystem: FileSystem = FileSystems.getDefault()): ProcessedArgument<Path, Path>

Convert the argument to a Path.

Parameters

exists - If true, fail if the given path does not exist

fileOkay - If false, fail if the given path is a file

folderOkay - If false, fail if the given path is a directory

writable - If true, fail if the given path is not writable

readable - If true, fail if the given path is not readable

fileSystem - If specified, the FileSystem with which to resolve paths.

fun RawOption.path(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false, fileSystem: FileSystem = java.nio.file.FileSystems.getDefault()): NullableOption<Path, Path>

Convert the option to a Path.

Parameters

exists - If true, fail if the given path does not exist

fileOkay - If false, fail if the given path is a file

folderOkay - If false, fail if the given path is a directory

writable - If true, fail if the given path is not writable

readable - If true, fail if the given path is not readable

fileSystem - If specified, the FileSystem with which to resolve paths.