net.sourceforge.argparse4j.impl.type

Class FileVerification

java.lang.Object

net.sourceforge.argparse4j.impl.type.FileVerification

public class FileVerification
extends Object

Verifies properties of files. This can be used by argument types to add extra validation to the file or directory paths that they accept.

To use it, create an instance, enable the desired verifications and call verify(ArgumentParser, Argument, File).

Since:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
boolean	verifyCanCreate
boolean	verifyCanExecute
boolean	verifyCanRead
boolean	verifyCanWrite
boolean	verifyCanWriteParent
boolean	verifyExists
boolean	verifyIsAbsolute
boolean	verifyIsDirectory
boolean	verifyIsFile
boolean	verifyNotExists

Constructor Summary

Constructors

Constructor and Description
FileVerification()

Method Summary

Modifier and Type	Method and Description
protected boolean	canExecute(File file)
protected boolean	canRead(File file)
protected boolean	canWrite(File file)
protected boolean	exists(File file)
protected boolean	isDirectory(File file)
protected boolean	isFile(File file)
FileVerification	or()
void	verify(ArgumentParser parser, Argument arg, File file)

Methods inherited from class java.lang.Object

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

Field Detail

verifyExists

public boolean verifyExists

verifyNotExists

public boolean verifyNotExists

verifyIsFile

public boolean verifyIsFile

verifyIsDirectory

public boolean verifyIsDirectory

verifyCanRead

public boolean verifyCanRead

verifyCanWrite

public boolean verifyCanWrite

verifyCanWriteParent

public boolean verifyCanWriteParent

verifyCanCreate

public boolean verifyCanCreate

verifyCanExecute

public boolean verifyCanExecute

verifyIsAbsolute

public boolean verifyIsAbsolute

Constructor Detail

FileVerification

public FileVerification()

Method Detail

or

public FileVerification or()

verify

public void verify(ArgumentParser parser,
                   Argument arg,
                   File file)
            throws ArgumentParserException

Throws:

ArgumentParserException

exists

protected boolean exists(File file)

isDirectory

protected boolean isDirectory(File file)

isFile

protected boolean isFile(File file)

canRead

protected boolean canRead(File file)

canWrite

protected boolean canWrite(File file)

canExecute

protected boolean canExecute(File file)