Package adams.data.io.output

Interface EmailFileWriter

All Superinterfaces:

EmailWriter, FileFormatHandler

All Known Implementing Classes:

AbstractEmailFileWriter, PlainTextEmailFileWriter, PropertiesEmailFileWriter

public interface EmailFileWriter
extends EmailWriter, FileFormatHandler

Interface for email writers that write to files.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

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	getOutput()	Returns the file to write the email to.
String	outputTipText()	Returns the tip text for this property.
void	setOutput(PlaceholderFile value)	Sets the file to write the email to.

Methods inherited from interface adams.data.io.output.EmailWriter

write

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension

Method Detail

setOutput

void setOutput(PlaceholderFile value)

Sets the file to write the email to.

Parameters:

value - the file

getOutput

PlaceholderFile getOutput()

Returns the file to write the email to.

Returns:

the file

outputTipText

String outputTipText()

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!)