FileValidator (Commons CLI2 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.cli2.validation.FileValidator

All Implemented Interfaces:

Validator
```
public class FileValidator
extends Object
implements Validator
```
The FileValidator validates the string argument values are files. If the value is a file, the string value in the List of values is replaced with the File instance. The following attributes can also be specified using the appropriate settors:
- writable
- readable
- hidden
- existing
- is a file
- is a directory
The following example shows how to limit the valid values for the config attribute to files that are readable, writeable, and that already existing.
```
 ...
 ArgumentBuilder builder = new ArgumentBuilder();
 FileValidator validator = FileValidator.getExistingFileInstance();
 validator.setReadable(true);
 validator.setWritable(true);

 Argument age =
     builder.withName("config");
            .withValidator(validator);
 
```
Author:

Rob Oxspring, John Keyes

Constructor Summary

Constructors
Constructor and Description

FileValidator()

Constructors
Constructor and Description
`FileValidator()`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`boolean`	`isHidden()` Returns whether the argument values must represent hidden files/directories.
`boolean`	`isReadable()` Returns whether the argument values must represent readable files/directories.
`boolean`	`isWritable()` Returns whether the argument values must represent writable files/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`	`setHidden(boolean hidden)` Specifies whether the argument values must represent hidden files/directories.
`void`	`setReadable(boolean readable)` Specifies whether the argument values must represent readable files/directories.
`void`	`setWritable(boolean writable)` Specifies whether the argument values must represent writable files/directories.
`void`	`validate(List values)` Validate the list of values against the list of permitted values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileValidator
```
public FileValidator()
```
- Method Detail
  - getExistingInstance
```
public static FileValidator getExistingInstance()
```
    Returns a FileValidator for existing files/directories.
    
    Returns:
    a FileValidator for existing files/directories.
  - getExistingFileInstance
```
public static FileValidator getExistingFileInstance()
```
    Returns a FileValidator for existing files.
    
    Returns:
    a FileValidator for existing files.
  - getExistingDirectoryInstance
```
public static FileValidator getExistingDirectoryInstance()
```
    Returns a FileValidator for existing directories.
    
    Returns:
    a FileValidator for existing directories.
  - validate
```
public void validate(List values)
              throws InvalidArgumentException
```
    Validate the list of values against the list of permitted values. If a value is valid, replace the string in the values List with the File instance.
    
    Specified by:
    
    validate in interface Validator
    
    Parameters:
    values - The values to validate.
    
    Throws:
    
    InvalidArgumentException - If any of the specified values are not valid.
    See Also:
    Validator.validate(java.util.List)
  - isDirectory
```
public boolean isDirectory()
```
    Returns whether the argument values must represent directories.
    
    Returns:
    whether the argument values must represent directories.
  - setDirectory
```
public void setDirectory(boolean directory)
```
    Specifies whether the argument values must represent directories.
    
    Parameters:
    directory - specifies whether the argument values must represent directories.
  - isExisting
```
public boolean isExisting()
```
    Returns whether the argument values must represent existing files/directories.
    
    Returns:
    whether the argument values must represent existing files/directories.
  - setExisting
```
public void setExisting(boolean existing)
```
    Specifies whether the argument values must represent existing files/directories.
    
    Parameters:
    existing - specifies whether the argument values must represent existing files/directories.
  - isFile
```
public boolean isFile()
```
    Returns whether the argument values must represent directories.
    
    Returns:
    whether the argument values must represent directories.
  - setFile
```
public void setFile(boolean file)
```
    Specifies whether the argument values must represent files.
    
    Parameters:
    file - specifies whether the argument values must represent files.
  - isHidden
```
public boolean isHidden()
```
    Returns whether the argument values must represent hidden files/directories.
    
    Returns:
    whether the argument values must represent hidden files/directories.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Specifies whether the argument values must represent hidden files/directories.
    
    Parameters:
    hidden - specifies whether the argument values must represent hidden files/directories.
  - isReadable
```
public boolean isReadable()
```
    Returns whether the argument values must represent readable files/directories.
    
    Returns:
    whether the argument values must represent readable files/directories.
  - setReadable
```
public void setReadable(boolean readable)
```
    Specifies whether the argument values must represent readable files/directories.
    
    Parameters:
    readable - specifies whether the argument values must represent readable files/directories.
  - isWritable
```
public boolean isWritable()
```
    Returns whether the argument values must represent writable files/directories.
    
    Returns:
    whether the argument values must represent writable files/directories.
  - setWritable
```
public void setWritable(boolean writable)
```
    Specifies whether the argument values must represent writable files/directories.
    
    Parameters:
    writable - specifies whether the argument values must represent writable files/directories.

Class FileValidator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileValidator

Method Detail

getExistingInstance

getExistingFileInstance

getExistingDirectoryInstance

validate

isDirectory

setDirectory

isExisting

setExisting

isFile

setFile

isHidden

setHidden

isReadable

setReadable

isWritable

setWritable