FMLiveSwitchLog Class Reference

Log utility class. More...

Instance Methods
(instancetype)	- init

Class Methods
(void)	+ addProvider:
	Registers a log provider as a logging target. More...
(void)	+ addProvider:level:
	Registers a log provider as a logging target, setting its log level in the process. More...
(void)	+ debugWithMessage:
	Logs a debug-level message. More...
(void)	+ debugWithMessage:ex:
	Logs a debug-level message. More...
(FMLiveSwitchLogLevel)	+ defaultLogLevel
	Gets the default log level. More...
(void)	+ errorWithMessage:
	Logs an error-level message. More...
(void)	+ errorWithMessage:ex:
	Logs an error-level message. More...
(void)	+ fatalWithMessage:
	Logs a fatal-level message. More...
(void)	+ fatalWithMessage:ex:
	Logs a fatal-level message. More...
(void)	+ flush
	Blocks until all logs are written out. More...
(NSObject< FMLiveSwitchILog > *)	+ getLoggerWithTag:
	Get a logger for a specific Tag. More...
(NSObject< FMLiveSwitchILog > *)	+ getLoggerWithTag:level:
	Get a logger for a specific Tag. More...
(NSObject< FMLiveSwitchILog > *)	+ getLoggerWithType:
	Get a logger for a specific Tag. More...
(NSObject< FMLiveSwitchILog > *)	+ getLoggerWithType:level:
	Get a logger for a specific Tag. More...
(void)	+ infoWithMessage:
	Logs an info-level message. More...
(void)	+ infoWithMessage:ex:
	Logs an info-level message. More...
(bool)	+ isDebugEnabled
	Gets a value indicating whether logging is enabled for debug-level messages for at least one of the registered providers. More...
(bool)	+ isErrorEnabled
	Gets a value indicating whether logging is enabled for error-level messages for at least one of the registered providers. More...
(bool)	+ isFatalEnabled
	Gets a value indicating whether logging is enabled for fatal-level messages for at least one of the registered providers. More...
(bool)	+ isInfoEnabled
	Gets a value indicating whether logging is enabled for info-level messages for at least one of the registered providers. More...
(bool)	+ isVerboseEnabled
	Gets a value indicating whether logging is enabled for verbose-level messages for at least one of the registered providers. More...
(bool)	+ isWarnEnabled
	Gets a value indicating whether logging is enabled for warn-level messages for at least one of the registered providers. More...
(FMLiveSwitchLog *)	+ log
(FMLiveSwitchLogLevel)	+ logLevel
	Gets the default log level. More...
(FMLiveSwitchLogProvider *)	+ provider
	Gets the first log provider. More...
(NSMutableArray *)	+ providers
	Gets the log providers. More...
(void)	+ registerProvider:
	Registers a log provider as a logging target. More...
(void)	+ registerProvider:level:
	Registers a log provider as a logging target, setting its log level in the process. More...
(bool)	+ removeProvider:
	Unregisters a log provider as a logging target. More...
(void)	+ removeProviders
	Unregisters all log providers as logging targets. More...
(void)	+ setDefaultLogLevel:
	Sets the default log level. More...
(void)	+ setLogLevel:
	Sets the default log level. More...
(void)	+ setProvider:
	Sets the first log provider. More...
(void)	+ setTagOverrideWithTag:level:
	Override the default log level for a specific tag. More...
(bool)	+ unregisterProvider:
	Unregisters a log provider as a logging target. More...
(void)	+ unregisterProviders
	Unregisters all log providers as logging targets. More...
(void)	+ verboseWithMessage:
	Logs a verbose-level message. More...
(void)	+ verboseWithMessage:ex:
	Logs a verbose-level message. More...
(void)	+ warnWithMessage:
	Logs a warn-level message. More...
(void)	+ warnWithMessage:ex:
	Logs a warn-level message. More...
(void)	+ writeLineWithText:
	Writes a line of text to the log. More...

Detailed Description

Log utility class.

Method Documentation

addProvider:

+ (void) addProvider:

(FMLiveSwitchLogProvider *)

provider

Registers a log provider as a logging target.

Alias for RegisterProvider.

Parameters

provider

The new provider.

addProvider:level:

+ (void) addProvider:		(FMLiveSwitchLogProvider *)	provider
level:		(FMLiveSwitchLogLevel)	level

Registers a log provider as a logging target, setting its log level in the process.

Alias for RegisterProvider.

Parameters

provider	The new provider.
level	The log level.

debugWithMessage:

+ (void) debugWithMessage:

(NSString *)

message

Logs a debug-level message.

Parameters

message

The message.

debugWithMessage:ex:

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

Logs a debug-level message.

Parameters

message	The message.
ex	The exception.

defaultLogLevel

+ (FMLiveSwitchLogLevel) defaultLogLevel

Gets the default log level.

errorWithMessage:

+ (void) errorWithMessage:

(NSString *)

message

Logs an error-level message.

Parameters

message

The message.

errorWithMessage:ex:

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

Logs an error-level message.

Parameters

message	The message.
ex	The exception.

fatalWithMessage:

+ (void) fatalWithMessage:

(NSString *)

message

Logs a fatal-level message.

Parameters

message

The message.

fatalWithMessage:ex:

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

Logs a fatal-level message.

Parameters

message	The message.
ex	The exception.

flush

+ (void) flush

Blocks until all logs are written out.

getLoggerWithTag:

+ (NSObject<FMLiveSwitchILog>*) getLoggerWithTag:

(NSString *)

tag

Get a logger for a specific Tag.

Parameters

tag	The tag to log to.

Returns

A ILog that will log to the specified tag.

getLoggerWithTag:level:

+ (NSObject<FMLiveSwitchILog>*) getLoggerWithTag:		(NSString *)	tag
level:		(FMLiveSwitchLogLevel)	level

Get a logger for a specific Tag.

Parameters

tag	The tag to log to.
level	Logger's default log level.

Returns

A ILog that will log to the specified tag.

getLoggerWithType:

+ (NSObject<FMLiveSwitchILog>*) getLoggerWithType:

(Class)

type

Get a logger for a specific Tag.

The tag is taken from the class namespace and name.

Parameters

type	The type to use as the tag.

Returns

A ILog that will log to the specified tag.

getLoggerWithType:level:

+ (NSObject<FMLiveSwitchILog>*) getLoggerWithType:		(Class)	type
level:		(FMLiveSwitchLogLevel)	level

Get a logger for a specific Tag.

The tag is taken from the class namespace and name.

Parameters

type	The type to use as the tag.
level	Logger's default log level.

Returns

A ILog that will log to the specified tag.

infoWithMessage:

+ (void) infoWithMessage:

(NSString *)

message

Logs an info-level message.

Parameters

message

The message.

infoWithMessage:ex:

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

Logs an info-level message.

Parameters

message	The message.
ex	The exception.

init

- (instancetype) init

isDebugEnabled

+ (bool) isDebugEnabled

Gets a value indicating whether logging is enabled for debug-level messages for at least one of the registered providers.

isErrorEnabled

+ (bool) isErrorEnabled

Gets a value indicating whether logging is enabled for error-level messages for at least one of the registered providers.

isFatalEnabled

+ (bool) isFatalEnabled

Gets a value indicating whether logging is enabled for fatal-level messages for at least one of the registered providers.

isInfoEnabled

+ (bool) isInfoEnabled

Gets a value indicating whether logging is enabled for info-level messages for at least one of the registered providers.

isVerboseEnabled

+ (bool) isVerboseEnabled

Gets a value indicating whether logging is enabled for verbose-level messages for at least one of the registered providers.

isWarnEnabled

+ (bool) isWarnEnabled

Gets a value indicating whether logging is enabled for warn-level messages for at least one of the registered providers.

log

+ (FMLiveSwitchLog*) log

logLevel

+ (FMLiveSwitchLogLevel) logLevel

Gets the default log level.

Deprecated:

Use DefaultLogLevel instead.

provider

+ (FMLiveSwitchLogProvider*) provider

Gets the first log provider.

providers

+ (NSMutableArray*) providers

Gets the log providers.

registerProvider:

+ (void) registerProvider:

(FMLiveSwitchLogProvider *)

provider

Registers a log provider as a logging target.

Parameters

provider

The provider.

registerProvider:level:

+ (void) registerProvider:		(FMLiveSwitchLogProvider *)	provider
level:		(FMLiveSwitchLogLevel)	level

Registers a log provider as a logging target, setting its log level in the process.

Parameters

provider	The provider.
level	The log level.

removeProvider:

+ (bool) removeProvider:

(FMLiveSwitchLogProvider *)

provider

Unregisters a log provider as a logging target.

Alias for UnregisterProvider.

Parameters

provider

The provider.

removeProviders

+ (void) removeProviders

Unregisters all log providers as logging targets.

Alias for UnregisterProviders.

setDefaultLogLevel:

+ (void) setDefaultLogLevel:

(FMLiveSwitchLogLevel)

value

Sets the default log level.

setLogLevel:

+ (void) setLogLevel:

(FMLiveSwitchLogLevel)

value

Sets the default log level.

Deprecated:

Use DefaultLogLevel instead.

setProvider:

+ (void) setProvider:

(FMLiveSwitchLogProvider *)

value

Sets the first log provider.

setTagOverrideWithTag:level:

+ (void) setTagOverrideWithTag:		(NSString *)	tag
level:		(FMLiveSwitchLogLevel)	level

Override the default log level for a specific tag.

Parameters

tag	The Tag to set the log level to.
level	The new loglevel to use.

unregisterProvider:

+ (bool) unregisterProvider:

(FMLiveSwitchLogProvider *)

provider

Unregisters a log provider as a logging target.

Parameters

provider

The provider.

unregisterProviders

+ (void) unregisterProviders

Unregisters all log providers as logging targets.

verboseWithMessage:

+ (void) verboseWithMessage:

(NSString *)

message

Logs a verbose-level message.

Parameters

message

The message.

verboseWithMessage:ex:

+ (void) verboseWithMessage:		(NSString *)	message
ex:		(NSException *)	ex

Logs a verbose-level message.

Parameters

message	The message.
ex	The exception.

warnWithMessage:

+ (void) warnWithMessage:

(NSString *)

message

Logs a warn-level message.

Parameters

message

The message.

warnWithMessage:ex:

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

Logs a warn-level message.

Parameters

message	The message.
ex	The exception.

writeLineWithText:

+ (void) writeLineWithText:

(NSString *)

text

Writes a line of text to the log.

Parameters

text	The text to write to the log.