fm.liveswitch.TextLogProvider Class Reference

Simple log provider that writes to a local string builder. More...

Public Member Functions

String clear ()
 Clears all text from the log and returns the former contents. More...
 
fm.liveswitch.IAction1< String > getCallback ()
 Gets a callback to invoke whenever text is written to the log. More...
 
String getText ()
 Gets the logged text. More...
 
void setCallback (fm.liveswitch.IAction1< String > value)
 Sets a callback to invoke whenever text is written to the log. More...
 
 TextLogProvider ()
 Initializes a new instance of the fm.liveswitch.TextLogProvider. More...
 
 TextLogProvider (fm.liveswitch.LogLevel level)
 Initializes a new instance of the fm.liveswitch.TextLogProvider class. More...
 
- Public Member Functions inherited from fm.liveswitch.LogProvider
fm.liveswitch.IFunction1< fm.liveswitch.LogEvent, Boolean > getFilter ()
 Gets a filter on the log provider. More...
 
fm.liveswitch.LogLevel getLevel ()
 Gets the log level. More...
 
void log (fm.liveswitch.LogEvent logEvent)
 Log a message. More...
 
 LogProvider ()
 Initializes a new instance of the fm.liveswitch.LogProvider class using fm.liveswitch.Log#getDefaultLogLevel as the log level. More...
 
void setFilter (fm.liveswitch.IFunction1< fm.liveswitch.LogEvent, Boolean > value)
 Sets a filter on the log provider. More...
 
void setLevel (fm.liveswitch.LogLevel value)
 Sets the log level. More...
 

Protected Member Functions

void doLog (fm.liveswitch.LogEvent logEvent)
 Logs a message at the specified log level. More...
 
- Protected Member Functions inherited from fm.liveswitch.LogProvider
String generateLogLine (fm.liveswitch.LogEvent logEvent)
 Generates a default log line. More...
 
String getPrefix (fm.liveswitch.LogLevel level, boolean includeTimestamp)
 Converts a log-level to a 5-character string for consistently-spaced character sequences. More...
 
int getProcessId ()
 Gets the current process id. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fm.liveswitch.LogProvider
static String getLogLevelString (fm.liveswitch.LogLevel level)
 Converts a log-level to a 5-character string for consistently-spaced character sequences. More...
 
static String getPrefixTimestamp (java.util.Date timestamp)
 Converts a timestamp to an ISO-8601-formatted string for rendering in a log message (YYYY-MM-DDThh:mm:ss.sssZ). More...
 
static String getProduct ()
 Returns the name of the current product. More...
 

Detailed Description

Simple log provider that writes to a local string builder.

Constructor & Destructor Documentation

◆ TextLogProvider() [1/2]

fm.liveswitch.TextLogProvider.TextLogProvider ( )

Initializes a new instance of the fm.liveswitch.TextLogProvider.

◆ TextLogProvider() [2/2]

fm.liveswitch.TextLogProvider.TextLogProvider ( fm.liveswitch.LogLevel  level)

Initializes a new instance of the fm.liveswitch.TextLogProvider class.

Parameters
levelThe log level.

Member Function Documentation

◆ clear()

String fm.liveswitch.TextLogProvider.clear ( )

Clears all text from the log and returns the former contents.

◆ doLog()

void fm.liveswitch.TextLogProvider.doLog ( fm.liveswitch.LogEvent  logEvent)
protected

Logs a message at the specified log level.

Parameters
logEventThe log event details.

Reimplemented from fm.liveswitch.LogProvider.

◆ getCallback()

fm.liveswitch.IAction1<String> fm.liveswitch.TextLogProvider.getCallback ( )

Gets a callback to invoke whenever text is written to the log.

◆ getText()

String fm.liveswitch.TextLogProvider.getText ( )

Gets the logged text.

◆ setCallback()

void fm.liveswitch.TextLogProvider.setCallback ( fm.liveswitch.IAction1< String >  value)

Sets a callback to invoke whenever text is written to the log.