FMLogProvider Class Reference

Inherits from NSObject
Declared in FM.h

Overview

Base class for all logging provider implementations.

– debugFormatWithFormat:args:

Logs a debuglevel message.

- (void)debugFormatWithFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs a debuglevel message.

Declared In

FM.h

– debugFormat:args:

Logs a debuglevel message.

- (void)debugFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs a debuglevel message.

Declared In

FM.h

– debugWithMessage:

Logs a debuglevel message.

- (void)debugWithMessage:(NSString *)message

Parameters

name="message">The

message.

Discussion

Logs a debuglevel message.

Declared In

FM.h

– debugWithMessage:ex:

Logs a debuglevel message.

- (void)debugWithMessage:(NSString *)message ex:(NSException *)ex

Parameters

name="ex">The

exception.
name="message">The

message.

Discussion

Logs a debuglevel message.

Declared In

FM.h

– errorFormatWithFormat:args:

Logs an errorlevel message.

- (void)errorFormatWithFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs an errorlevel message.

Declared In

FM.h

– errorFormat:args:

Logs an errorlevel message.

- (void)errorFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs an errorlevel message.

Declared In

FM.h

– errorWithMessage:

Logs an errorlevel message.

- (void)errorWithMessage:(NSString *)message

Parameters

name="message">The

message.

Discussion

Logs an errorlevel message.

Declared In

FM.h

– errorWithMessage:ex:

Logs an errorlevel message.

- (void)errorWithMessage:(NSString *)message ex:(NSException *)ex

Parameters

name="ex">The

exception.
name="message">The

message.

Discussion

Logs an errorlevel message.

Declared In

FM.h

– fatalFormatWithFormat:args:

Logs a fatallevel message.

- (void)fatalFormatWithFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs a fatallevel message.

Declared In

FM.h

– fatalFormat:args:

Logs a fatallevel message.

- (void)fatalFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs a fatallevel message.

Declared In

FM.h

– fatalWithMessage:

Logs a fatallevel message.

- (void)fatalWithMessage:(NSString *)message

Parameters

name="message">The

message.

Discussion

Logs a fatallevel message.

Declared In

FM.h

– fatalWithMessage:ex:

Logs a fatallevel message.

- (void)fatalWithMessage:(NSString *)message ex:(NSException *)ex

Parameters

name="ex">The

exception.
name="message">The

message.

Discussion

Logs a fatallevel message.

Declared In

FM.h

– formatAndWriteLineWithFormat:args:

Writes a line of text to the log.

- (void)formatAndWriteLineWithFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Writes a line of text to the log.

Declared In

FM.h

+ getPrefixLevelWithLevel:

Converts a loglevel to a 5-character string for consistently-spaced character sequences.

+ (NSString *)getPrefixLevelWithLevel:(FMLogLevel)level

Parameters

name="level">The

log level. The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

Discussion

Converts a loglevel to a 5-character string for consistently-spaced character sequences.

Declared In

FM.h

+ getPrefixLevel:

Converts a loglevel to a 5-character string for consistently-spaced character sequences.

+ (NSString *)getPrefixLevel:(FMLogLevel)level

Parameters

name="level">The

log level. The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

Discussion

Converts a loglevel to a 5-character string for consistently-spaced character sequences.

Declared In

FM.h

+ getPrefixTimestampWithTimestamp:

Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

+ (NSString *)getPrefixTimestampWithTimestamp:(NSDate *)timestamp

Parameters

name="timestamp">The

timestamp. The timestamp as a formatted string.

Discussion

Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

Declared In

FM.h

+ getPrefixTimestamp:

Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

+ (NSString *)getPrefixTimestamp:(NSDate *)timestamp

Parameters

name="timestamp">The

timestamp. The timestamp as a formatted string.

Discussion

Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

Declared In

FM.h

+ getPrefixWithLevel:includeTimestamp:

Converts a loglevel to a 5-character string for consistently-spaced character sequences.

+ (NSString *)getPrefixWithLevel:(FMLogLevel)level includeTimestamp:(bool)includeTimestamp

Parameters

name="level">The

log level.
name="includeTimestamp">Whether

to include a timestamp in the prefix. The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

Discussion

Converts a loglevel to a 5-character string for consistently-spaced character sequences.

Declared In

FM.h

– infoFormatWithFormat:args:

Logs an infolevel message.

- (void)infoFormatWithFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs an infolevel message.

Declared In

FM.h

– infoFormat:args:

Logs an infolevel message.

- (void)infoFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs an infolevel message.

Declared In

FM.h

– infoWithMessage:

Logs an infolevel message.

- (void)infoWithMessage:(NSString *)message

Parameters

name="message">The

message.

Discussion

Logs an infolevel message.

Declared In

FM.h

– infoWithMessage:ex:

Logs an infolevel message.

- (void)infoWithMessage:(NSString *)message ex:(NSException *)ex

Parameters

name="ex">The

exception.
name="message">The

message.

Discussion

Logs an infolevel message.

Declared In

FM.h

– init

Initializes a new instance of the class.

- (id)init

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– isDebugEnabled

Gets a value indicating whether logging is enabled for debuglevel messages. true if logging is enabled for debuglevel messages; otherwise, false.

- (bool)isDebugEnabled

Discussion

Gets a value indicating whether logging is enabled for debuglevel messages. true if logging is enabled for debuglevel messages; otherwise, false.

Declared In

FM.h

– isEnabledWithLevel:

Determines whether logging is enabled for the specified log level.

- (bool)isEnabledWithLevel:(FMLogLevel)level

Parameters

name="level">The

log level. true if logging is enabled for the specified log level; otherwise, false.

Discussion

Determines whether logging is enabled for the specified log level.

Declared In

FM.h

– isErrorEnabled

Gets a value indicating whether logging is enabled for errorlevel messages. true if logging is enabled for errorlevel messages; otherwise, false.

- (bool)isErrorEnabled

Discussion

Gets a value indicating whether logging is enabled for errorlevel messages. true if logging is enabled for errorlevel messages; otherwise, false.

Declared In

FM.h

– isFatalEnabled

Gets a value indicating whether logging is enabled for fatallevel messages. true if logging is enabled for fatallevel messages; otherwise, false.

- (bool)isFatalEnabled

Discussion

Gets a value indicating whether logging is enabled for fatallevel messages. true if logging is enabled for fatallevel messages; otherwise, false.

Declared In

FM.h

– isInfoEnabled

Gets a value indicating whether logging is enabled for infolevel messages. true if logging is enabled for infolevel messages; otherwise, false.

- (bool)isInfoEnabled

Discussion

Gets a value indicating whether logging is enabled for infolevel messages. true if logging is enabled for infolevel messages; otherwise, false.

Declared In

FM.h

– isWarnEnabled

Gets a value indicating whether logging is enabled for warnlevel messages. true if logging is enabled for warnlevel messages; otherwise, false.

- (bool)isWarnEnabled

Discussion

Gets a value indicating whether logging is enabled for warnlevel messages. true if logging is enabled for warnlevel messages; otherwise, false.

Declared In

FM.h

– level

Gets the log level.

- (FMLogLevel)level

Discussion

Gets the log level.

Declared In

FM.h

+ logProvider

Initializes a new instance of the class.

+ (FMLogProvider *)logProvider

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– logWithLevel:message:

Logs a message at the specified log level.

- (void)logWithLevel:(FMLogLevel)level message:(NSString *)message

Parameters

name="level">The

log level.
name="message">The

message.

Discussion

Logs a message at the specified log level.

Declared In

FM.h

– logWithLevel:message:ex:

Logs a message at the specified log level.

- (void)logWithLevel:(FMLogLevel)level message:(NSString *)message ex:(NSException *)ex

Parameters

name="level">The

log level.
name="ex">The

exception.
name="message">The

message.

Discussion

Logs a message at the specified log level.

Declared In

FM.h

– setLevel:

Sets the log level.

- (void)setLevel:(FMLogLevel)value

Discussion

Sets the log level.

Declared In

FM.h

– warnFormatWithFormat:args:

Logs a warnlevel message.

- (void)warnFormatWithFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs a warnlevel message.

Declared In

FM.h

– warnFormat:args:

Logs a warnlevel message.

- (void)warnFormat:(NSString *)format args:(NSMutableArray *)args

Parameters

name="format">A

composite format string.
name="args">An

array containing zero or more objects to format.

Discussion

Logs a warnlevel message.

Declared In

FM.h

– warnWithMessage:

Logs a warnlevel message.

- (void)warnWithMessage:(NSString *)message

Parameters

name="message">The

message.

Discussion

Logs a warnlevel message.

Declared In

FM.h

– warnWithMessage:ex:

Logs a warnlevel message.

- (void)warnWithMessage:(NSString *)message ex:(NSException *)ex

Parameters

name="ex">The

exception.
name="message">The

message.

Discussion

Logs a warnlevel message.

Declared In

FM.h

– writeLineWithText:

Writes a line of text to the log.

- (void)writeLineWithText:(NSString *)text

Parameters

name="text">The

text to write to the log.

Discussion

Writes a line of text to the log.

Declared In

FM.h