AbstractEmailWriter (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.io.output.AbstractEmailWriter

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEmailFileWriter
```
public abstract class AbstractEmailWriter
extends AbstractOptionHandler
implements EmailWriter
```
Ancestor for classes that write 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

AbstractEmailWriter()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(Email email)`	Hook method for performing checks before writing the emails.
`protected abstract String`	`doWrite(Email email)`	Performs the actual writing.
`String`	`write(Email email)`	Writes 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
  - AbstractEmailWriter
```
public AbstractEmailWriter()
```
- Method Detail
  - check
```
protected String check(Email email)
```
    Hook method for performing checks before writing the emails.
    
    Default implementation checks only whether an email has been provided.
    
    Returns:
    
    the error message, null if everything OK
  - doWrite
```
protected abstract String doWrite(Email email)
```
    Performs the actual writing.
    
    Parameters:
    
    email - the email to write
    
    Returns:
    
    the error message, null if everything OK
  - write
```
public String write(Email email)
```
    Writes the email.
    
    Specified by:
    
    write in interface EmailWriter
    
    Parameters:
    
    email - the email to write
    
    Returns:
    
    the error message, null if everything OK