adams.data.io.input
Interface EmailFileReader

All Superinterfaces:

EmailReader

All Known Implementing Classes:

AbstractEmailFileReader, PropertiesEmailFileReader

public interface EmailFileReader
extends EmailReader

Interface for readers that read from files.

Version:

$Revision: 7123 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

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

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.

Returns:

the description

getFormatExtensions

String[] getFormatExtensions()

Returns the extension(s) of the file format (without dot).

Returns:

the extensions (no dot!)