Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Log

Log utility class.

Hierarchy

  • Log

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Log(): Log

  • Returns Log

Properties

Static Private __fmicelinkLogInitialized

__fmicelinkLogInitialized: boolean = false
internal

Static Private fm_icelink_Log___staticLogger

fm_icelink_Log___staticLogger: ILog
internal

Methods

getTypeString

  • getTypeString(): string

  • Returns string

Static debug

  • debug(message: string, ex: Exception): void
  • debug(message: string): void
  • Logs a debug-level message.

    Parameters

    • message: string

      The message.

    • ex: Exception

      The exception.

    Returns void

  • Logs a debug-level message.

    Parameters

    • message: string

      The message.

    Returns void

Static error

  • error(message: string): void
  • error(message: string, ex: Exception): void
  • Logs an error-level message.

    Parameters

    • message: string

      The message.

    Returns void

  • Logs an error-level message.

    Parameters

    • message: string

      The message.

    • ex: Exception

      The exception.

    Returns void

Static fatal

  • fatal(message: string, ex: Exception): void
  • fatal(message: string): void
  • Logs a fatal-level message.

    Parameters

    • message: string

      The message.

    • ex: Exception

      The exception.

    Returns void

  • Logs a fatal-level message.

    Parameters

    • message: string

      The message.

    Returns void

Static flush

  • flush(): void
  • Blocks until all logs are written out.

    Returns void

Static fmicelinkLogInitialize

  • fmicelinkLogInitialize(): void
  • internal

    Returns void

Static getIsDebugEnabled

  • getIsDebugEnabled(): boolean

  • Gets a value indicating whether logging is enabled for debug-level messages.

    true if logging is enabled for debug-level messages; otherwise, false.

    Returns boolean

Static getIsErrorEnabled

  • getIsErrorEnabled(): boolean

  • Gets a value indicating whether logging is enabled for error-level messages.

    true if logging is enabled for error-level messages; otherwise, false.

    Returns boolean

Static getIsFatalEnabled

  • getIsFatalEnabled(): boolean

  • Gets a value indicating whether logging is enabled for fatal-level messages.

    true if logging is enabled for fatal-level messages; otherwise, false.

    Returns boolean

Static getIsInfoEnabled

  • getIsInfoEnabled(): boolean

  • Gets a value indicating whether logging is enabled for info-level messages.

    true if logging is enabled for info-level messages; otherwise, false.

    Returns boolean

Static getIsVerboseEnabled

  • getIsVerboseEnabled(): boolean

  • Gets a value indicating whether logging is enabled for verbose-level messages.

    true if logging is enabled for verbose-level messages; otherwise, false.

    Returns boolean

Static getIsWarnEnabled

  • getIsWarnEnabled(): boolean

  • Gets a value indicating whether logging is enabled for warn-level messages.

    true if logging is enabled for warn-level messages; otherwise, false.

    Returns boolean

Static getLogLevel

  • getLogLevel(): LogLevel
  • Gets the default log level.

    Returns LogLevel

Static getLogger

  • getLogger(type: Type): ILog
  • getLogger(tag: string): ILog
  • getLogger(type: Type, level: LogLevel): ILog
  • getLogger(tag: string, level: LogLevel): ILog
  • Get a logger for a specific Tag. The tag is taken from the class namespace and name.

    Parameters

    • type: Type

      The type to use as the tag.

    Returns ILog

    A ILog that will log to the specified tag.

  • Get a logger for a specific Tag.

    Parameters

    • tag: string

      The tag to log to.

    Returns ILog

    A ILog that will log to the specified tag.

  • Get a logger for a specific Tag. The tag is taken from the class namespace and name.

    Parameters

    • type: Type

      The type to use as the tag.

    • level: LogLevel

      Logger's default log level.

    Returns ILog

    A ILog that will log to the specified tag.

  • Get a logger for a specific Tag.

    Parameters

    • tag: string

      The tag to log to.

    • level: LogLevel

      Logger's default log level.

    Returns ILog

    A ILog that will log to the specified tag.

Static getProvider

  • getProvider(): LogProvider
  • Gets the first log provider.

    Returns LogProvider

Static info

  • info(message: string, ex: Exception): void
  • info(message: string): void
  • Logs an info-level message.

    Parameters

    • message: string

      The message.

    • ex: Exception

      The exception.

    Returns void

  • Logs an info-level message.

    Parameters

    • message: string

      The message.

    Returns void

Static registerProvider

  • registerProvider(provider: LogProvider): void
  • Register a log provider to be logged to.

    Parameters

    • provider: LogProvider

      The new provider.

    Returns void

Static removeProvider

  • removeProvider(provider: LogProvider): void
  • Removes a log provider from the list.

    Parameters

    • provider: LogProvider

      The provider to remove.

    Returns void

Static setLogLevel

  • setLogLevel(value: LogLevel): void
  • Sets the default log level.

    Parameters

    • value: LogLevel

    Returns void

Static setProvider

  • setProvider(value: LogProvider): void
  • Sets the first log provider.

    Parameters

    • value: LogProvider

    Returns void

Static setTagOverride

  • setTagOverride(tag: string, level: LogLevel): void
  • Override the default log level for a specific tag.

    Parameters

    • tag: string

      The Tag to set the log level to.

    • level: LogLevel

      The new loglevel to use.

    Returns void

Static verbose

  • verbose(message: string, ex: Exception): void
  • verbose(message: string): void
  • Logs a verbose-level message.

    Parameters

    • message: string

      The message.

    • ex: Exception

      The exception.

    Returns void

  • Logs a verbose-level message.

    Parameters

    • message: string

      The message.

    Returns void

Static warn

  • warn(message: string, ex: Exception): void
  • warn(message: string): void
  • Logs a warn-level message.

    Parameters

    • message: string

      The message.

    • ex: Exception

      The exception.

    Returns void

  • Logs a warn-level message.

    Parameters

    • message: string

      The message.

    Returns void

Static writeLine

  • writeLine(text: string): void
  • Writes a line of text to the log.

    Parameters

    • text: string

      The text to write to the log.

    Returns void