Package adams.flow.sink.simplelogging.output

Class RotatingFileOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.simplelogging.output.AbstractSimpleOutput

adams.flow.sink.simplelogging.output.FileOutput

adams.flow.sink.simplelogging.output.RotatingFileOutput

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, FlowContextHandler, SimpleOutput, Serializable

public class RotatingFileOutput
extends FileOutput

Appends the log messages to the specified file, but also allows for rotating them.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumLogFiles	the number of log files to use.
protected boolean	m_Rotated	whether the logs have been rotated.

Fields inherited from class adams.flow.sink.simplelogging.output.FileOutput

m_OutputFile

Fields inherited from class adams.flow.sink.simplelogging.output.AbstractSimpleOutput

m_FlowContext

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doLogMessage(String msg)	Logs the (formatted) logging message.
int	getNumLogFiles()	Returns the number of logs to use.
String	globalInfo()	Returns a string describing the object.
String	numLogFilesTipText()	Returns the tip text for this property.
void	setNumLogFiles(int value)	Sets the number of logs to use.

Methods inherited from class adams.flow.sink.simplelogging.output.FileOutput

check, getOutputFile, getQuickInfo, outputFileTipText, setOutputFile

Methods inherited from class adams.flow.sink.simplelogging.output.AbstractSimpleOutput

getFlowContext, logMessage, requiresFlowContext, setFlowContext

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_NumLogFiles

protected int m_NumLogFiles

the number of log files to use.

m_Rotated

protected boolean m_Rotated

whether the logs have been rotated.

Constructor Detail

RotatingFileOutput

public RotatingFileOutput()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class FileOutput

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 OptionHandler

Overrides:

defineOptions in class FileOutput

setNumLogFiles

public void setNumLogFiles(int value)

Sets the number of logs to use.

Parameters:

value - the number of log files

getNumLogFiles

public int getNumLogFiles()

Returns the number of logs to use.

Returns:

the number of log files

numLogFilesTipText

public String numLogFilesTipText()

Returns the tip text for this property.

Returns:

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

doLogMessage

protected String doLogMessage(String msg)

Logs the (formatted) logging message.

Overrides:

doLogMessage in class FileOutput

Parameters:

msg - the message to log

Returns:

null if successful, otherwise error message