Module net.sourceforge.argparse4j
Class FileVerification
java.lang.Object
net.sourceforge.argparse4j.impl.type.FileVerification
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
FieldsModifier and TypeFieldDescriptionprivate FileVerification
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
canExecute
(File file) protected boolean
protected boolean
protected boolean
protected boolean
isDirectory
(File file) protected boolean
or()
private void
throwException
(ArgumentParser parser, Argument arg, File file, String messageKey) void
verify
(ArgumentParser parser, Argument arg, File file) private void
verifyCanCreate
(ArgumentParser parser, Argument arg, File file) private void
verifyCanExecute
(ArgumentParser parser, Argument arg, File file) private void
verifyCanRead
(ArgumentParser parser, Argument arg, File file) private void
verifyCanWrite
(ArgumentParser parser, Argument arg, File file) private void
verifyCanWriteParent
(ArgumentParser parser, Argument arg, File file) private void
verifyExists
(ArgumentParser parser, Argument arg, File file) private void
verifyIsAbsolute
(ArgumentParser parser, Argument arg, File file) private void
verifyIsDirectory
(ArgumentParser parser, Argument arg, File file) private void
verifyIsFile
(ArgumentParser parser, Argument arg, File file) private void
verifyNotExists
(ArgumentParser parser, Argument arg, File file) private void
verifyPermissions
(ArgumentParser parser, Argument arg, File file) private void
verifyPresenceAndType
(ArgumentParser parser, Argument arg, File file) private boolean
-
Field Details
-
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
-
-
Constructor Details
-
FileVerification
public FileVerification()
-
-
Method Details
-
or
-
verify
- Throws:
ArgumentParserException
-
verifyStep
- Throws:
ArgumentParserException
-
verifyPresenceAndType
private void verifyPresenceAndType(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyPermissions
private void verifyPermissions(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyExists
private void verifyExists(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyNotExists
private void verifyNotExists(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyIsFile
private void verifyIsFile(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyIsDirectory
private void verifyIsDirectory(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyCanRead
private void verifyCanRead(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyCanWrite
private void verifyCanWrite(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyCanWriteParent
private void verifyCanWriteParent(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyCanCreate
private void verifyCanCreate(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyCanExecute
private void verifyCanExecute(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
verifyIsAbsolute
private void verifyIsAbsolute(ArgumentParser parser, Argument arg, File file) throws ArgumentParserException - Throws:
ArgumentParserException
-
throwException
private void throwException(ArgumentParser parser, Argument arg, File file, String messageKey) throws ArgumentParserException - Throws:
ArgumentParserException
-
exists
-
isDirectory
-
isFile
-
canRead
-
canWrite
-
canExecute
-