Package adams.flow.rest.interceptor.outgoing

Class LogFileGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator<LogFile>

adams.flow.rest.interceptor.outgoing.LogFileGenerator

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class LogFileGenerator
extends AbstractOutInterceptorGenerator<LogFile>

Generator for LogFile.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.io.PlaceholderFile	m_LogFile	the file to write to.

Fields inherited from class adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator

m_Enabled, m_LastInterceptor

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected LogFile	doGenerate()	Generates the actual interceptor for incoming messages.
adams.core.io.PlaceholderFile	getLogFile()	Returns the log file to write to.
String	globalInfo()	Returns a string describing the object.
String	logFileTipText()	Returns the tip text for this property.
void	setLogFile(adams.core.io.PlaceholderFile value)	Sets the log file to write to.

Methods inherited from class adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator

check, cleanUp, enabledTipText, generate, getEnabled, getLastInterceptor, hasLastInterceptor, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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_LogFile

protected adams.core.io.PlaceholderFile m_LogFile

the file to write to.

Constructor Detail

LogFileGenerator

public LogFileGenerator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractOutInterceptorGenerator<LogFile>

setLogFile

public void setLogFile(adams.core.io.PlaceholderFile value)

Sets the log file to write to.

Parameters:

value - the file to write to

getLogFile

public adams.core.io.PlaceholderFile getLogFile()

Returns the log file to write to.

Returns:

the file to write to

logFileTipText

public String logFileTipText()

Returns the tip text for this property.

Returns:

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

doGenerate

protected LogFile doGenerate()

Generates the actual interceptor for incoming messages.

Specified by:

doGenerate in class AbstractOutInterceptorGenerator<LogFile>

Returns:

the interceptor