ufm::util::Logger 類別 參考文件

類別ufm::util::Logger的繼承圖:

公開型態
enum struct	Level : uint8 {   NONE = 0 , SEVERE = 1 , WARNING = 2 , INFO = 3 ,   CONFIG = 4 , FINE = 5 , FINER = 6 , FINEST = 7 }

公開方法(Public Methods)
	Logger (ufm::io::PrintStream &printStream, const char *name=nullptr)
	Construct a new Logger object.
virtual	~Logger (void) override
	Destroy the object.
	operator ufm::io::PrintStream & ()
	Implicit conversion operator to ufm::io::PrintStream&.
	operator ufm::lang::Appendable & ()
	Implicit conversion operator to ufm::lang::Appendable&.
Logger &	log (Level level=Level::INFO, const char *message="", bool finalize=true)
	開始記錄一條新日誌
Logger &	finest (const char *message="", bool finalize=true)
	記錄一條最詳細資訊日誌
Logger &	finer (const char *message="", bool finalize=true)
	記錄一條更詳細資訊日誌
Logger &	fine (const char *message="", bool finalize=true)
	記錄一條詳細資訊日誌
Logger &	config (const char *message="", bool finalize=true)
	記錄一條配置日誌
Logger &	info (const char *message="", bool finalize=true)
	記錄一條資訊日誌
Logger &	warning (const char *message="", bool finalize=true)
	記錄一條警告日誌
Logger &	severe (const char *message="", bool finalize=true)
	記錄一條嚴重錯誤日誌
Logger &	setLevel (Level level)
	設定 Logger 的日誌等級
Level	getLevel (void) const
	取得目前 Logger 的日誌等級。
const char *	getName (void) const
	取得 Logger 名稱。
Logger &	append (bool b)
	追加布林值日誌訊息。
Logger &	append (char c)
	追加字元日誌訊息。
Logger &	append (double d)
	追加 double 浮點數日誌訊息。
Logger &	append (float f)
	追加 float 浮點數日誌訊息。
Logger &	append (int i)
	追加整數日誌訊息。
Logger &	append (const char *str)
	追加 C 字串日誌訊息。
Logger &	append (const ufm::lang::Strings &str)
	追加一條日誌消息（字串物件）
Logger &	format (const char *format,...)
	追加一條格式化日誌消息
Logger &	finalize (void)
	結束當前日誌並強制輸出緩衝內容
公開方法(Public Methods) 繼承自 ufm::lang::Object
void *	operator new (size_t n)
	使用運算子 new 分配記憶體
void *	operator new (size_t n, void *p)
	在指定記憶體上調用運算子 new
virtual ufm::lang::Object &	getObject (void) override
	取得對應的 Object 物件
void	delay (int milliseconds) const
	延遲指定的毫秒數進行執行緒等待
bool	equals (Object *object) const
	判斷與另一物件是否為相同參照（指標型態比較）
bool	equals (Object &object) const
	判斷與另一物件是否為相同參照（參照型態比較）
void	wait (void) const
	使當前線程等待直到被通知
bool	wait (int timeout) const
	等待通知或超時
bool	yield (void) const
	讓執行緒讓渡控制權給同優先權的下一個執行緒
int	lock (void) const
	核心鎖定，鎖定期間禁止線程切換
int	unlock (void) const
	核心解鎖
ufm::sys::Thread *	currentThread (void) const
	取得當前執行緒指標
virtual int	hashcode (void) const
	返回對象的哈希碼值。支持這種方法是為了散列表，如HashMap提供的那樣。
公開方法(Public Methods) 繼承自 ufm::lang::Interface
virtual	~Interface (void)=default
	虛擬析構函式

列舉型態成員說明文件

Level

enum struct ufm::util::Logger::Level : uint8

strong

列舉值
SEVERE	嚴重錯誤
WARNING	警告
INFO	資訊
CONFIG	配置
FINE	詳細資訊
FINER	更詳細資訊
FINEST	最詳細資訊

建構子與解構子說明文件

Logger()

ufm::util::Logger::Logger	(	ufm::io::PrintStream &	printStream,
		const char *	name = nullptr )

Construct a new Logger object.

參數

printStream	用於輸出的 PrintStream 物件
name	日誌名稱，若為 nullptr 則不使用名稱

函式成員說明文件

append() [1/7]

Logger & ufm::util::Logger::append ( bool b )

inline

追加布林值日誌訊息。

僅當 Logger 等級（vLevel）大於等於目前設定等級（vCurrentLevel）時才會輸出。

參數

b

欲追加的布林值。

傳回值

Logger& 傳回當前 Logger 物件參考，可用於鏈式調用。

append() [2/7]

Logger & ufm::util::Logger::append ( char c )

inline

追加字元日誌訊息。

僅當 Logger 等級（vLevel）大於等於目前設定等級（vCurrentLevel）時才會輸出。

參數

c

欲追加的字元。

傳回值

Logger& 傳回當前 Logger 物件參考，可用於鏈式調用。

append() [3/7]

Logger & ufm::util::Logger::append ( const char * str )

inline

追加 C 字串日誌訊息。

僅當 Logger 等級（vLevel）大於等於目前設定等級（vCurrentLevel）時才會輸出。

參數

str	欲追加的 C 字串。

傳回值

Logger& 傳回當前 Logger 物件參考，可用於鏈式調用。

append() [4/7]

Logger & ufm::util::Logger::append ( const ufm::lang::Strings & str )

inline

追加一條日誌消息（字串物件）

將 ufm::lang::Strings 物件內容追加到日誌輸出流中。 僅當當前 Logger 的等級（vLevel）大於或等於當前設定的日誌等級（vCurrentLevel）時才會輸出。

參數

str	欲追加的 ufm::lang::Strings 字串物件消息

傳回值

Logger& 返回當前 Logger 物件的參考，可用於鏈式調用

append() [5/7]

Logger & ufm::util::Logger::append ( double d )

inline

追加 double 浮點數日誌訊息。

僅當 Logger 等級（vLevel）大於等於目前設定等級（vCurrentLevel）時才會輸出。

參數

d	欲追加的 double 浮點數。

傳回值

Logger& 傳回當前 Logger 物件參考，可用於鏈式調用。

append() [6/7]

Logger & ufm::util::Logger::append ( float f )

inline

追加 float 浮點數日誌訊息。

僅當 Logger 等級（vLevel）大於等於目前設定等級（vCurrentLevel）時才會輸出。

參數

f	欲追加的 float 浮點數。

傳回值

Logger& 傳回當前 Logger 物件參考，可用於鏈式調用。

append() [7/7]

Logger & ufm::util::Logger::append ( int i )

inline

追加整數日誌訊息。

僅當 Logger 等級（vLevel）大於等於目前設定等級（vCurrentLevel）時才會輸出。

參數

i

欲追加的整數。

傳回值

Logger& 傳回當前 Logger 物件參考，可用於鏈式調用。

config()

Logger & ufm::util::Logger::config ( const char * message = "", bool finalize = true )

inline

記錄一條配置日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

finalize()

Logger & ufm::util::Logger::finalize

(

void

)

結束當前日誌並強制輸出緩衝內容

通常用於明確標示一條日誌的結束，並將緩衝區內容立即輸出到目標裝置。 可用於手動控制日誌分段或換行。

傳回值

Logger&

返回當前 Logger 物件的參考，可用於鏈式調用

fine()

Logger & ufm::util::Logger::fine ( const char * message = "", bool finalize = true )

inline

記錄一條詳細資訊日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

finer()

Logger & ufm::util::Logger::finer ( const char * message = "", bool finalize = true )

inline

記錄一條更詳細資訊日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

finest()

Logger & ufm::util::Logger::finest ( const char * message = "", bool finalize = true )

inline

記錄一條最詳細資訊日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

format()

Logger & ufm::util::Logger::format	(	const char *	format,
			... )

追加一條格式化日誌消息

以 printf 風格格式化字串與參數，並將結果追加到日誌輸出流中。 僅當當前 Logger 的等級（vLevel）大於或等於當前設定的日誌等級（vCurrentLevel）時才會輸出。

參數

format	格式化字串（printf 樣式）
...	可變參數列表，對應格式化字串中的格式說明符

傳回值

Logger& 返回當前 Logger 物件的參考，可用於鏈式調用

getLevel()

Level ufm::util::Logger::getLevel ( void ) const

inline

取得目前 Logger 的日誌等級。

傳回值

Level 目前 Logger 設定的日誌等級。

getName()

const char * ufm::util::Logger::getName ( void ) const

inline

取得 Logger 名稱。

傳回值

const char* Logger 名稱字串，若無名稱則為 nullptr。

info()

Logger & ufm::util::Logger::info ( const char * message = "", bool finalize = true )

inline

記錄一條資訊日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

log()

Logger & ufm::util::Logger::log	(	Level	level = Level::INFO,
		const char *	message = "",
		bool	finalize = true )

開始記錄一條新日誌

參數

level	日誌級別
message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

operator ufm::io::PrintStream &()

ufm::util::Logger::operator ufm::io::PrintStream & ( )

inline

Implicit conversion operator to ufm::io::PrintStream&.

This allows the Logger object to be used as a PrintStream reference, enabling direct output operations on the Logger's PrintStream.

傳回值

Reference to the internal PrintStream object.

operator ufm::lang::Appendable &()

ufm::util::Logger::operator ufm::lang::Appendable & ( )

inline

Implicit conversion operator to ufm::lang::Appendable&.

This allows the Logger object to be used as an Appendable reference, enabling direct output operations on the Logger's PrintStream.

傳回值

Reference to the internal PrintStream object as Appendable.

setLevel()

Logger & ufm::util::Logger::setLevel

(

Level

level

)

設定 Logger 的日誌等級

變更 Logger 物件的日誌等級，僅等級大於等於此值的訊息才會被輸出。

參數

level

欲設定的日誌等級（Level 枚舉）

傳回值

Logger& 返回當前 Logger 物件的參考，可用於鏈式調用

severe()

Logger & ufm::util::Logger::severe ( const char * message = "", bool finalize = true )

inline

記錄一條嚴重錯誤日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

warning()

Logger & ufm::util::Logger::warning ( const char * message = "", bool finalize = true )

inline

記錄一條警告日誌

參數

message	日誌消息
finalize	是否在結束時自動調用 finalize()

傳回值

Logger& 返回當前 Logger 物件的參考

---

此類別(class) 文件是由下列檔案中產生:

• Logger.h