FileFormatter.Annotation (QA JGiven Commons 1.0.5-SNAPSHOT API)

```
@AnnotationFormat(FileFormatter.class)
@Retention(RUNTIME)
@Target({PARAMETER,ANNOTATION_TYPE})
public static @interface FileFormatter.Annotation
```
Formatter annotation for Files. If the file exists and its size are below specified maxFileSizeToRead() then its contents will be written to the report, otherwise the file name itself will be written to the report.

Author:

aherscu

- Optional Element Summary
  
  Optional Elements
  Modifier and Type Optional Element Description
  
  int maxFileSizeToRead
  
  int value

- Element Detail
  - maxFileSizeToRead
```
int maxFileSizeToRead
```
    Returns:
    
    the maximum file size to read, larger files will not be read; defaults to -1, meaning no maximum will be imposed
    
    Default:
    
    -1
- - value
```
int value
```
    Returns:
    
    amount of file text to output in the report; defaults to -1, meaning the entire file will be rendered in the report
    
    Default:
    
    -1