Brook Tardigrade

Class TBrookLogger

Description
Hierarchy
Fields
Methods
Properties

Unit

BrookLogger

Declaration

type TBrookLogger = class(TComponent)

Description

Component that writes log to a predefined output type.

Hierarchy

Overview

Methods

Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public function GetOutputClass: TBrookLoggerOutputClass; inline;
Public procedure Open;
Public procedure Close;
Public procedure Log(const ALevel, AMessage: string); inline;
Public procedure Fail(const ALevel: string; AException: Exception); inline;
Public procedure Info(const AMessage: string); inline;
Public procedure Hint(const AMessage: string); inline;
Public procedure Warn(const AMessage: string); inline;
Public procedure Debug(const AMessage: string); inline;
Public procedure Error(AException: Exception); inline;

Properties

Public property Output: TBrookLoggerOutput read GetOutput;
Published property Active: Boolean read FActive write SetActive stored IsActiveStored;
Published property Levels: TBrookLoggerLevels read FLevels write FLevels;
Published property OutputName: string read FOutputName write SetOutputName stored IsOutputNameStored;
Published property Filters: TStringList read FFilters write SetFilters;
Published property Options: TStringList read FOptions write SetOptions;

Description

Methods

Public constructor Create(AOwner: TComponent); override;

Creates an instance of TBrookLogger.

Parameters
AOwner[in]
Owner component.
Public destructor Destroy; override;

Destroys an instance of TBrookLogger.

Public function GetOutputClass: TBrookLoggerOutputClass; inline;

Gets an output log class from the classes register.

Public procedure Open;

Enabled the logger component.

Public procedure Close;

Disables the logger component.

Public procedure Log(const ALevel, AMessage: string); inline;

Appends a message to the output log.

Parameters
ALevel[in]
Log level.
AMessage[in]
Log message.
Public procedure Fail(const ALevel: string; AException: Exception); inline;

Appends an exception message to the output log.

Parameters
ALevel[in]
Log level.
AException[in]
Log exception.
Public procedure Info(const AMessage: string); inline;

Appends a message to the output log as information level.

Parameters
AMessage[in]
Log message.
Public procedure Hint(const AMessage: string); inline;

Appends a message to the output log as hint level.

Parameters
AMessage[in]
Log message.
Public procedure Warn(const AMessage: string); inline;

Appends a message to the output log as warning level.

Parameters
AMessage[in]
Log message.
Public procedure Debug(const AMessage: string); inline;

Appends a message to the output log as debug level.

Parameters
AMessage[in]
Log message.
Public procedure Error(AException: Exception); inline;

Appends a message to the output log as error level.

Parameters
AMessage[in]
Log message.

Properties

Public property Output: TBrookLoggerOutput read GetOutput;

Current active log output.

Published property Active: Boolean read FActive write SetActive stored IsActiveStored;

Activates the logger component.

Published property Levels: TBrookLoggerLevels read FLevels write FLevels;

Retains the log levels.

Published property OutputName: string read FOutputName write SetOutputName stored IsOutputNameStored;

Name of the chosen output type.

Published property Filters: TStringList read FFilters write SetFilters;

List containing the filtered log levels.

Published property Options: TStringList read FOptions write SetOptions;

List containing additional options to the chosen output.

Generated by PasDoc 0.16.0.