adams.data.io.input
Class AbstractEmailReader

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.input.AbstractEmailReader

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, EmailReader, Serializable

Direct Known Subclasses:

AbstractEmailFileReader

public abstract class AbstractEmailReader
extends AbstractOptionHandler
implements EmailReader

Ancestor for classes that read emails.

Version:

$Revision: 7123 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractEmailReader()

Method Summary

protected void	check() Hook method for performing checks before reading the emails.
protected abstract Email	doRead() Performs the actual reading.
Email	read() Reads the email.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, defineOptions, destroy, finishInit, getDebugLevel, getOptionManager, globalInfo, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractEmailReader

public AbstractEmailReader()

Method Detail

check

protected void check()

Hook method for performing checks before reading the emails. Throws IllegalStateException in case something is wrong.

Default implementation does nothing.

doRead

protected abstract Email doRead()

Performs the actual reading.

Returns:

the email that was read, null in case of error

read

public Email read()

Reads the email.

Specified by:

read in interface EmailReader

Returns:

the email, null in case of an error