Package adams.flow.sink.simplelogging.format

Interface SimpleFormat

All Superinterfaces:

FlowContextHandler, QuickInfoSupporter

All Known Implementing Classes:

AbstractSimpleFormat, NoFormat, TimestampedFormat

public interface SimpleFormat
extends FlowContextHandler, QuickInfoSupporter

Interface for schemes that format logging messages.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	formatMessage(String msg)	Formats the logging message and returns the updated message.
boolean	requiresFlowContext()	Returns whether flow context is really required.

Methods inherited from interface adams.flow.core.FlowContextHandler

getFlowContext, setFlowContext

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Method Detail

requiresFlowContext

boolean requiresFlowContext()

Returns whether flow context is really required.

Returns:

true if required

formatMessage

String formatMessage(String msg)

Formats the logging message and returns the updated message.

Parameters:

msg - the message to format

Returns:

the formatted message