Module net.sourceforge.argparse4j
Class FileVerification
- java.lang.Object
-
- net.sourceforge.argparse4j.impl.type.FileVerification
-
public class FileVerification extends java.lang.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 Description private FileVerification
nextFileVerification
boolean
verifyCanCreate
boolean
verifyCanExecute
boolean
verifyCanRead
boolean
verifyCanWrite
boolean
verifyCanWriteParent
boolean
verifyExists
boolean
verifyIsAbsolute
boolean
verifyIsDirectory
boolean
verifyIsFile
boolean
verifyNotExists
-
Constructor Summary
Constructors Constructor Description FileVerification()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canExecute(java.io.File file)
protected boolean
canRead(java.io.File file)
protected boolean
canWrite(java.io.File file)
protected boolean
exists(java.io.File file)
protected boolean
isDirectory(java.io.File file)
protected boolean
isFile(java.io.File file)
FileVerification
or()
private void
throwException(ArgumentParser parser, Argument arg, java.io.File file, java.lang.String messageKey)
void
verify(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyCanCreate(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyCanExecute(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyCanRead(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyCanWrite(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyCanWriteParent(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyExists(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyIsAbsolute(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyIsDirectory(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyIsFile(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyNotExists(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyPermissions(ArgumentParser parser, Argument arg, java.io.File file)
private void
verifyPresenceAndType(ArgumentParser parser, Argument arg, java.io.File file)
private boolean
verifyStep(FileVerificationStep step)
-
-
-
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
-
nextFileVerification
private FileVerification nextFileVerification
-
-
Method Detail
-
or
public FileVerification or()
-
verify
public void verify(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyStep
private boolean verifyStep(FileVerificationStep step) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyPresenceAndType
private void verifyPresenceAndType(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyPermissions
private void verifyPermissions(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyExists
private void verifyExists(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyNotExists
private void verifyNotExists(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyIsFile
private void verifyIsFile(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyIsDirectory
private void verifyIsDirectory(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyCanRead
private void verifyCanRead(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyCanWrite
private void verifyCanWrite(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyCanWriteParent
private void verifyCanWriteParent(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyCanCreate
private void verifyCanCreate(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyCanExecute
private void verifyCanExecute(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
verifyIsAbsolute
private void verifyIsAbsolute(ArgumentParser parser, Argument arg, java.io.File file) throws ArgumentParserException
- Throws:
ArgumentParserException
-
throwException
private void throwException(ArgumentParser parser, Argument arg, java.io.File file, java.lang.String messageKey) throws ArgumentParserException
- Throws:
ArgumentParserException
-
exists
protected boolean exists(java.io.File file)
-
isDirectory
protected boolean isDirectory(java.io.File file)
-
isFile
protected boolean isFile(java.io.File file)
-
canRead
protected boolean canRead(java.io.File file)
-
canWrite
protected boolean canWrite(java.io.File file)
-
canExecute
protected boolean canExecute(java.io.File file)
-
-