net.sourceforge.argparse4j.ext.java7

Class PathArgumentType

java.lang.Object

net.sourceforge.argparse4j.ext.java7.PathArgumentType

All Implemented Interfaces:

ArgumentType<Path>

public class PathArgumentType
extends Object
implements ArgumentType<Path>

ArgumentType subclass for Path type, using fluent style API.

This object can convert path string to Path object. The command-line programs traditionally accept the file path "-" as standard input. This object supports this when acceptSystemIn() is used. Also there are several convenient verification features such as checking readability or existence.

Since:

0.8.0

Constructor Summary

Constructors

Constructor and Description
PathArgumentType() Create an instance using the default file system for resolving the path.
PathArgumentType(FileSystem fileSystem) Create an instance using the given file system for resolving the path.

Method Summary

Modifier and Type	Method and Description
PathArgumentType	acceptSystemIn() If the argument is "-", accept it as standard input.
Path	convert(ArgumentParser parser, Argument arg, String value)
PathArgumentType	or() Start a new verification group.
PathArgumentType	verifyCanCreate() Verifies that the specified path is writable.
PathArgumentType	verifyCanExecute() Verifies that the specified path is executable.
PathArgumentType	verifyCanRead() Verifies that the specified path is readable.
PathArgumentType	verifyCanWrite() Verifies that the specified path is writable.
PathArgumentType	verifyCanWriteParent() Verifies that the parent directory of the specified path is writable.
PathArgumentType	verifyExists() Verifies that the specified path exists.
PathArgumentType	verifyIsAbsolute() Verifies that the specified path is an absolute path.
PathArgumentType	verifyIsDirectory() Verifies that the specified path is a directory.
PathArgumentType	verifyIsFile() Verifies that the specified path is a regular file.
PathArgumentType	verifyNotExists() Verifies that the specified path does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathArgumentType

public PathArgumentType()

Create an instance using the default file system for resolving the path.

PathArgumentType

public PathArgumentType(FileSystem fileSystem)

Create an instance using the given file system for resolving the path.

Warning: Using the non-default file system disables all file verifications.

Parameters:

fileSystem - The file system to use for resolving paths

Method Detail

acceptSystemIn

public PathArgumentType acceptSystemIn()

If the argument is "-", accept it as standard input. If this method is used, all verification methods will be ignored.

Returns:

this

verifyExists

public PathArgumentType verifyExists()

Verifies that the specified path exists. If the verification fails, error will be reported.

Returns:

this

verifyNotExists

public PathArgumentType verifyNotExists()

Verifies that the specified path does not exist. If the verification fails, error will be reported.

Returns:

this

verifyIsFile

public PathArgumentType verifyIsFile()

Verifies that the specified path is a regular file. If the verification fails, error will be reported.

Returns:

this

verifyIsDirectory

public PathArgumentType verifyIsDirectory()

Verifies that the specified path is a directory. If the verification fails, error will be reported.

Returns:

this

verifyCanRead

public PathArgumentType verifyCanRead()

Verifies that the specified path is readable. If the verification fails, error will be reported.

Returns:

this

verifyCanWrite

public PathArgumentType verifyCanWrite()

Verifies that the specified path is writable. If the verification fails, error will be reported.

Returns:

this

verifyCanWriteParent

public PathArgumentType verifyCanWriteParent()

Verifies that the parent directory of the specified path is writable. If the verification fails, error will be reported.

Returns:

this

verifyCanCreate

public PathArgumentType verifyCanCreate()

Verifies that the specified path is writable. If the verification fails, error will be reported.

Returns:

this

verifyCanExecute

public PathArgumentType verifyCanExecute()

Verifies that the specified path is executable. If the verification fails, error will be reported.

Returns:

this

verifyIsAbsolute

public PathArgumentType verifyIsAbsolute()

Verifies that the specified path is an absolute path. If the verification fails, error will be reported.

Returns:

this

or

public PathArgumentType or()

Start a new verification group. Of all verification groups at least 1 must be verified successfully for the path to be accepted.

Returns:

this

convert

public Path convert(ArgumentParser parser,
                    Argument arg,
                    String value)
             throws ArgumentParserException

Specified by:

convert in interface ArgumentType<Path>

Throws:

ArgumentParserException