net.dpml.cli.validation
public class FileValidator extends Object implements Validator
FileValidator
validates the string argument
values are files. If the value is a file, the string value in
the java.util.List of values is replaced with the
java.io.File instance.
The following attributes can also be specified using the
appropriate settors:
... ArgumentBuilder builder = new ArgumentBuilder(); FileValidator validator = FileValidator.getExistingFileInstance(); Argument age = builder.withName("config"); .withValidator(validator);
Version: @PROJECT-VERSION@
Method Summary | |
---|---|
static FileValidator | getExistingDirectoryInstance()
Returns a FileValidator for existing directories.
|
static FileValidator | getExistingFileInstance()
Returns a FileValidator for existing files.
|
static FileValidator | getExistingInstance()
Returns a FileValidator for existing files/directories.
|
boolean | isDirectory()
Returns whether the argument values must represent directories.
|
boolean | isExisting()
Returns whether the argument values must represent existing
files/directories.
|
boolean | isFile()
Returns whether the argument values must represent directories.
|
void | setDirectory(boolean directory)
Specifies whether the argument values must represent directories.
|
void | setExisting(boolean existing)
Specifies whether the argument values must represent existing
files/directories.
|
void | setFile(boolean file)
Specifies whether the argument values must represent files.
|
void | validate(List values)
Validate the list of values against the list of permitted values.
|
FileValidator
for existing directories.
Returns: a FileValidator
for existing directories.
FileValidator
for existing files.
Returns: a FileValidator
for existing files.
FileValidator
for existing files/directories.
Returns: a FileValidator
for existing files/directories.
Returns: whether the argument values must represent directories.
Returns: whether the argument values must represent existing files/directories.
Returns: whether the argument values must represent directories.
Parameters: directory specifies whether the argument values must represent directories.
Parameters: existing specifies whether the argument values must represent existing files/directories.
Parameters: file specifies whether the argument values must represent files.
values
java.util.List with the java.io.File instance.
Parameters: values the list of values to validate
Throws: InvalidArgumentException if a value is invalid
See Also: validate