AbstractEmailReader (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.io.input.AbstractEmailReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, EmailReader, Serializable

Direct Known Subclasses:

AbstractEmailFileReader
```
public abstract class AbstractEmailReader
extends AbstractOptionHandler
implements EmailReader
```
Ancestor for classes that read emails.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractEmailReader()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`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, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- 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