EmailFileReader (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

EmailReader, FileFormatHandler

All Known Implementing Classes:

AbstractEmailFileReader, EmlEmailFileReader, PropertiesEmailFileReader
```
public interface EmailFileReader
extends EmailReader, FileFormatHandler
```
Interface for readers that read from files.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getFormatDescription()`	Returns the description of the file format.
`String[]`	`getFormatExtensions()`	Returns the extension(s) of the file format (without dot).
`PlaceholderFile`	`getInput()`	Returns the file to read.
`String`	`inputTipText()`	Returns the tip text for this property.
`void`	`setInput(PlaceholderFile value)`	Sets the file to read.

Methods inherited from interface adams.data.io.input.EmailReader
read

Methods inherited from interface adams.core.io.FileFormatHandler
getDefaultFormatExtension

- Method Detail
  - setInput
```
void setInput(PlaceholderFile value)
```
    Sets the file to read.
    
    Parameters:
    
    value - the file
  - getInput
```
PlaceholderFile getInput()
```
    Returns the file to read.
    
    Returns:
    
    the object
  - inputTipText
```
String inputTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getFormatDescription
```
String getFormatDescription()
```
    Returns the description of the file format.
    
    Specified by:
    
    getFormatDescription in interface FileFormatHandler
    
    Returns:
    
    the description
  - getFormatExtensions
```
String[] getFormatExtensions()
```
    Returns the extension(s) of the file format (without dot).
    
    Specified by:
    
    getFormatExtensions in interface FileFormatHandler
    
    Returns:
    
    the extensions (no dot!)