Package adams.flow.transformer.imaptransformer

Class AbstractIMAPFolderOperation<I,O>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.imaptransformer.AbstractIMAPOperation<I,O>

adams.flow.transformer.imaptransformer.AbstractIMAPFolderOperation<I,O>

Type Parameters:

I - the type of output that is being received

O - the type of output that is being generated

All Implemented Interfaces:

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

Direct Known Subclasses:

ReceiveEmail

public abstract class AbstractIMAPFolderOperation<I,O>
extends AbstractIMAPOperation<I,O>

Ancestor of operations that work on a specific folder.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Folder	the folder to query.

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
AbstractIMAPFolderOperation()

Method Summary

Modifier and Type	Method	Description
protected String	check(IMAPConnection conn, I input)	Hook method for checks before executing the operation.
void	defineOptions()	Adds options to the internal list of options.
String	folderTipText()	Returns the tip text for this property.
protected String	getDefaultFolder()	Returns the default folder.
String	getFolder()	Returns the folder to query.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
void	setFolder(String value)	Sets the folder to query.

Methods inherited from class adams.flow.transformer.imaptransformer.AbstractIMAPOperation

accepts, doExecute, execute, generates

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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

Field Detail

m_Folder

protected String m_Folder

the folder to query.

Constructor Detail

AbstractIMAPFolderOperation

public AbstractIMAPFolderOperation()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultFolder

protected String getDefaultFolder()

Returns the default folder.

Returns:

the default

setFolder

public void setFolder(String value)

Sets the folder to query.

Parameters:

value - the folder

getFolder

public String getFolder()

Returns the folder to query.

Returns:

the folder

folderTipText

public String folderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractIMAPOperation<I,O>

Returns:

null if no info available, otherwise short string

check

protected String check(IMAPConnection conn,
                       I input)

Hook method for checks before executing the operation.

Overrides:

check in class AbstractIMAPOperation<I,O>

Parameters:

conn - the connection to use

input - the input data

Returns:

the generated output, can be null