log4shib::Category(3)

📦 version 2.0.1, in opensuse-leap 16.0

🌸 NAME 🌸

okay so this page is log4shib::Category(3) from the Library Functions Manual, and it's about log4shib::Category — literally the central class in the log4j package. main character energy, no cap 👑

✨ SYNOPSIS ✨

#include <Category.hh>

Inherited by log4shib::FixedContextCategory.

💅 Public Member Functions 💅

  • virtual ~Category () — the destructor for Category. bye bestie 🫶
  • virtual const std::string & getName () const throw () — hands you back the category name. it's a const ref, she's not giving you a copy.
  • virtual void setPriority (Priority::Value priority) — sets the priority of this Category.
  • virtual Priority::Value getPriority () const throw () — gives you the Priority that's been assigned to this Category, if any.
  • virtual Priority::Value getChainedPriority () const throw () — starts at this Category and climbs the category hierarchy looking for a set priority, then returns it. it's giving search-up-the-family-tree.
  • virtual bool isPriorityEnabled (Priority::Value priority) const throw () — true when the chained priority of the Category is equal to or higher than the priority you passed in.
  • virtual void addAppender (Appender *appender) — adds an Appender to this Category.
  • virtual void addAppender (Appender &appender) — adds an Appender for this Category.
  • void setAppender (Appender *appender) — adds an Appender to this Category.
  • void setAppender (Appender &appender) — adds an Appender for this Category.
  • virtual Appender * getAppender () const — returns the first Appender for this Category, or NULL if no Appender has been set.
  • virtual Appender * getAppender (const std::string &name) const — returns the Appender you named for this Category, or NULL if that Appender isn't attached to this Category. sad but true 😭
  • virtual AppenderSet getAllAppenders () const — returns the set of Appenders currently attached to this Catogory. (that spelling is theirs, not mine 💀)
  • virtual void removeAllAppenders () — removes every appender for this Category. clean slate era.
  • virtual void removeAppender (Appender *appender) — removes the specified appender for this Category.
  • bool ownsAppender () const throw () — true if the Category owns the first Appender in its Appender set.
  • virtual bool ownsAppender (Appender *appender) const throw () — true if the Category owns that Appender.
  • virtual void callAppenders (const LoggingEvent &event) throw () — calls the appenders in the hierarchy, starting at this one.
  • virtual void setAdditivity (bool additivity) — sets the additivity flag for this Category instance.
  • virtual bool getAdditivity () const throw () — returns the additivity flag for this Category instance.
  • virtual Category * getParent () throw () — returns the parent category of this category, or NULL if this category is the root category.
  • virtual const Category * getParent () const throw () — same deal, const flavour: the parent category, or NULL if this is the root category.
  • virtual void log (Priority::Value priority, const char *stringFormat,...) throw () — logs a message with the priority you specify.
  • virtual void log (Priority::Value priority, const std::string &message) throw () — logs a message with the priority you specify. string edition.
  • virtual void logva (Priority::Value priority, const char *stringFormat, va_list va) throw () — logs a message with the priority you specify, va_list style.
  • void debug (const char *stringFormat,...) throw () — logs a message with debug priority.
  • void debug (const std::string &message) throw () — logs a message with debug priority.
  • bool isDebugEnabled () const throw () — true if the Category will log messages with priority DEBUG.
  • CategoryStream debugStream () — returns a CategoryStream with priority DEBUG.
  • void info (const char *stringFormat,...) throw () — logs a message with info priority.
  • void info (const std::string &message) throw () — logs a message with info priority.
  • bool isInfoEnabled () const throw () — true if the Category will log messages with priority INFO.
  • CategoryStream infoStream () — returns a CategoryStream with priority INFO.
  • void notice (const char *stringFormat,...) throw () — logs a message with notice priority.
  • void notice (const std::string &message) throw () — logs a message with notice priority.
  • bool isNoticeEnabled () const throw () — true if the Category will log messages with priority NOTICE.
  • CategoryStream noticeStream () — returns a CategoryStream with priority NOTICE.
  • void warn (const char *stringFormat,...) throw () — logs a message with warn priority.
  • void warn (const std::string &message) throw () — logs a message with warn priority.
  • bool isWarnEnabled () const throw () — true if the Category will log messages with priority WARN.
  • CategoryStream warnStream () — returns a CategoryStream with priority WARN.
  • void error (const char *stringFormat,...) throw () — logs a message with error priority.
  • void error (const std::string &message) throw () — logs a message with error priority.
  • bool isErrorEnabled () const throw () — true if the Category will log messages with priority ERROR.
  • CategoryStream errorStream () — returns a CategoryStream with priority ERROR.
  • void crit (const char *stringFormat,...) throw () — logs a message with crit priority.
  • void crit (const std::string &message) throw () — logs a message with crit priority.
  • bool isCritEnabled () const throw () — true if the Category will log messages with priority CRIT.
  • CategoryStream critStream () — returns a CategoryStream with priority CRIT.
  • void alert (const char *stringFormat,...) throw () — logs a message with alert priority.
  • void alert (const std::string &message) throw () — logs a message with alert priority.
  • bool isAlertEnabled () const throw () — true if the Category will log messages with priority ALERT.
  • CategoryStream alertStream () throw () — returns a CategoryStream with priority ALERT. (not me noticing this is the only *Stream with a throw () … 👀)
  • void emerg (const char *stringFormat,...) throw () — logs a message with emerg priority.
  • void emerg (const std::string &message) throw () — logs a message with emerg priority.
  • bool isEmergEnabled () const throw () — true if the Category will log messages with priority EMERG.
  • CategoryStream emergStream () — returns a CategoryStream with priority EMERG.
  • void fatal (const char *stringFormat,...) throw () — logs a message with fatal priority.
  • void fatal (const std::string &message) throw () — logs a message with fatal priority.
  • bool isFatalEnabled () const throw () — true if the Category will log messages with priority FATAL.
  • CategoryStream fatalStream () — returns a CategoryStream with priority FATAL.
  • virtual CategoryStream getStream (Priority::Value priority) — returns a CategoryStream with the given Priority.
  • virtual CategoryStream operator<< (Priority::Value priority) — returns a CategoryStream with the given Priority. operator energy ✨

🌟 Static Public Member Functions 🌟

  • static Category & getRoot () — returns the root of the Category hierarchy.
  • static void setRootPriority (Priority::Value priority) — sets the priority of the root Category.
  • static Priority::Value getRootPriority () throw () — gets the priority of the root Category.
  • static Category & getInstance (const std::string &name) — instantiates a Category with the name name.
  • static Category * exists (const std::string &name) — if the named category exists (in the default hierarchy) then you get a reference to the category, otherwise you get NULL. vibe check on your category 🫶
  • static std::vector< Category * > * getCurrentCategories () — returns every currently defined category as a vector of Category pointers.
  • static void shutdown () — this method will remove all Appenders from Categories.XXX.

🫶 Protected Member Functions 🫶

  • Category (const std::string &name, Category *parent, Priority::Value priority=Priority::NOTSET) — the Constructor.
  • virtual void _logUnconditionally (Priority::Value priority, const char *format, va_list arguments) throw () — the va_list one.
  • virtual void _logUnconditionally2 (Priority::Value priority, const std::string &message) throw () — unconditionally logs a message with the specified priority.

🧚 Friends 🧚

  • class HierarchyMaintainer — yes bestie, it's in the group chat 💅

🦋 Detailed Description 🦋

This is the central class in the log4j package.

One of the distintive features of log4j (and hence log4shib) are hierarchal categories and their evaluation. (the spelling of distintive and hierarchal is copied straight from the source, don't come for me 😭)

🎀 Constructor & Destructor Documentation 🎀

log4shib::Category::~Category () [virtual]

Destructor for Category.

log4shib::Category::Category (const std::string & name, Category * parent, Priority::Value priority = Priority::NOTSET) [protected]

Constructor.

Parameters:

  • name — the fully qualified name of this Category
  • parent — the parent of this parent, or NULL for the root Category
  • priority — the priority for this Category. Defaults to Priority::NOTSET

🔥 Member Function Documentation 🔥

void log4shib::Category::_logUnconditionally (Priority::Value priority, const char * format, va_list arguments) [protected], [virtual]

void log4shib::Category::_logUnconditionally2 (Priority::Value priority, const std::string & message) [protected], [virtual]

Unconditionally logs a message with the specified priority.

Parameters:

  • priority — The priority of this log message.
  • message — string to write in the log file

Reimplemented in log4shib::FixedContextCategory.

void log4shib::Category::addAppender (Appender & appender) [virtual]

Adds an Appender for this Category. This method does not pass ownership from the caller to the Category.

Since: 0.2.7

Parameters:

  • appender — The Appender this category has to log to.

Reimplemented in log4shib::FixedContextCategory.

void log4shib::Category::addAppender (Appender * appender) [virtual]

Adds an Appender to this Category. This method does pass ownership from the caller to the Category.

Since: 0.2.7

Parameters:

  • appender — The Appender to wich this category has to log. (their spelling again, i'm innocent 🙈)

Exceptions:

  • std::invalid_argument if the appender is NULL.

Reimplemented in log4shib::FixedContextCategory.

void log4shib::Category::alert (const char * stringFormat, ...)

Logs a message with alert priority.

Parameters:

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

void log4shib::Category::alert (const std::string & message)

Logs a message with alert priority.

Parameters:

  • message — string to write in the log file

CategoryStream log4shib::Category::alertStream () [inline]

Returns a CategoryStream with priority ALERT.

Returns: The CategoryStream.

part 2 is literally right there, don't go anywhere bestie 🦋✨

💅 void log4shib::Category::callAppenders (const LoggingEvent & event) — [virtual]

Okay so bestie, this one sends it. It calls the appenders up the whole hierarchy starting right here at this category, and if there are literally no appenders to be found anywhere, it emits a warning. 🫶

Major thing to know: this method always calls all the appenders inherited from the hierarchy, no cap — it just straight up circumvents any evaluation of whether to log or not to log the particular log request. It doesn't check the vibe first, it just goes. 😭

Parameters

  • event — the LogginEvent to log.

Reimplemented in log4shib::FixedContextCategory.

🌸 void log4shib::Category::crit (const char * stringFormat, ...)

Logs a message with crit priority. Yelling, but in a cunty way. 💅

Parameters

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

🦋 void log4shib::Category::crit (const std::string & message)

Same energy, but you're handing it a std::string.

Parameters

  • message — string to write in the log file

✨ CategoryStream log4shib::Category::critStream () — [inline]

Hands you back a CategoryStream with priority CRIT. Stream it, queen. 🎀

Returns

  • The CategoryStream.

🍓 void log4shib::Category::debug (const char * stringFormat, ...)

Log a message with debug priority. Little baby sentences for the girlies who need all the details. 🔍

Parameters

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

🧚 void log4shib::Category::debug (const std::string & message)

Debug, but with a std::string this time.

Parameters

  • message — string to write in the log file

⭐ CategoryStream log4shib::Category::debugStream () — [inline]

Returns a CategoryStream with priority DEBUG.

Returns

  • The CategoryStream.

🔥 void log4shib::Category::emerg (const char * stringFormat, ...)

Log a message with emerg priority. This is the the building is on fire one, bestie. Literally the emergency-est. 🚨

Parameters

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

💀 void log4shib::Category::emerg (const std::string & message)

Same priority, std::string flavoured.

Parameters

  • message — string to write in the log file

🌈 CategoryStream log4shib::Category::emergStream () — [inline]

Returns a CategoryStream with priority EMERG.

Returns

  • The CategoryStream.

🎀 void log4shib::Category::error (const char * stringFormat, ...)

Log a message with error priority. You know the vibe — something's broken and we're being dramatic about it. 😭

Parameters

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

💜 void log4shib::Category::error (const std::string & message)

The std::string version of the same thing.

Parameters

  • message — string to write in the log file

🫶 CategoryStream log4shib::Category::errorStream () — [inline]

Returns a CategoryStream with priority ERROR.

Returns

  • The CategoryStream.

👑 Category * log4shib::Category::exists (const std::string & name) — [static]

Vibe check on a category name! 💅 If the named category exists (in the default hierarchy) then it returns a reference to the category, otherwise it returns NULL. That's it, that's the whole girl.

Since 0.2.7

🔥 void log4shib::Category::fatal (const char * stringFormat, ...)

Log a message with fatal priority. NB. priority 'fatal' is equivalent to 'emerg' — they're the same girl, different outfit. 💀

Since 0.2.7

Parameters

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

🦋 void log4shib::Category::fatal (const std::string & message)

Log a message with fatal priority. NB. priority 'fatal' is equivalent to 'emerg'.

Since 0.2.7

Parameters

  • message — string to write in the log file

✨ CategoryStream log4shib::Category::fatalStream () — [inline]

Returns a CategoryStream with priority FATAL. NB. priority 'fatal' is equivalent to 'emerg' — yes we're saying it again, no cap. 🎀

Since 0.2.7

Returns

  • The CategoryStream.

🌸 bool log4shib::Category::getAdditivity () const — [virtual]

Returns the additivity flag for this Category instance. Is she additive? Enquiring minds. 👀

Reimplemented in log4shib::FixedContextCategory.

🎀 AppenderSet log4shib::Category::getAllAppenders () const — [virtual]

Returns the set of Appenders currently attached to this Catogory — yes that's how it's spelled in the docs, bless. 💖 You get all of them.

Since 0.3.1

Returns

  • The set of attached Appenders.

Reimplemented in log4shib::FixedContextCategory.

🫶 Appender * log4shib::Category::getAppender () const — [virtual]

Returns the first Appender for this Category, or NULL if no Appender has been set.

Deprecated — use getAppender(const std::string&) instead, bestie. This one's giving legacy code energy. 💀

Returns

  • The Appender.

Reimplemented in log4shib::FixedContextCategory.

💜 Appender * log4shib::Category::getAppender (const std::string & name) const — [virtual]

Returns the specified Appender for this Category, or NULL if the Appender is not attached to this Category. Name-specific, iconic, the upgrade we deserved. ✨

Since 0.2.7

Returns

  • The Appender.

Reimplemented in log4shib::FixedContextCategory.

🦋 Priority::Value log4shib::Category::getChainedPriority () const — [virtual]

Starting from this Category, search the category hierarchy for a set priority and return it. Otherwise, return the priority of the root category. Climb the tree, girl. 🌳

The Category class is designed so that this method executes as quickly as possible — she's fast, she's optimised, she's that girl. 🔥

Reimplemented in log4shib::FixedContextCategory.

👑 std::vector< Category * > * log4shib::Category::getCurrentCategories () — [static]

Returns all the currently defined categories as a vector of Category pointers. ⚠️ Note: this function does not pass ownership of the categories in the vector to the caller — only the ownership of the vector. But, and I cannot stress this enough, vector<Category&>* is not legal C++, so we can't follow the default ownership conventions. It's giving "the language said no". 😭

Unlike in log4j, the root category is included in the returned set. We're inclusive here. 🫶

Since 0.3.2. Before 0.3.2 this method returned a std::set

⭐ Category & log4shib::Category::getInstance (const std::string & name) — [static]

Instantiate a Category with name name. This method does not set the priority of the category — which is by default Priority::NOTSET. So don't come for her about priorities, she literally has none set. 🙈

Parameters

  • name — The name of the category to retrieve.

💖 const std::string & log4shib::Category::getName () const — [virtual]

Return the category name. Short, sweet, to the point. Name check: passed. ✅

Returns

  • The category name.

🌸 Category * log4shib::Category::getParent () — [virtual]

Returns the parent category of this category, or NULL if the category is the root category. Root has no mother, she is the mother. 👑

Returns

  • the parent category.

🌸 const Category * log4shib::Category::getParent () const — [virtual]

Same thing but const — the respectful version. Returns the parent category of this category, or NULL if the category is the root category.

Returns

  • the parent category.

🎀 Priority::Value log4shib::Category::getPriority () const — [virtual]

Returns the assigned Priority, if any, for this Category. Note the "if any" — she might be Priority::NOTSET and that's valid.

Returns

  • Priority — the assigned Priority, can be Priority::NOTSET

Reimplemented in log4shib::FixedContextCategory.

👑 Category & log4shib::Category::getRoot () — [static]

Return the root of the Category hierarchy. The root category is always instantiated and available. It's name is the empty string — literally "", the void, the origin, the mother. 🌌

Unlike in log4j, calling Category.getInstance("") does retrieve the root category and not a category just under root named "". Important distinction, bestie, write it down. 📝

Returns

  • The root category

⭐ Priority::Value log4shib::Category::getRootPriority () — [static]

Get the priority of the root Category. Simple as.

Returns

  • the priority of the root category

🌈 CategoryStream log4shib::Category::getStream (Priority::Value priority) — [virtual]

Return a CategoryStream with given Priority. You pick the priority, she builds you the stream. Custom order, main character service. 💅

Parameters

  • priority — The Priority of the CategoryStream.

Returns

  • The requested CategoryStream.

🦋 void log4shib::Category::info (const char * stringFormat, ...)

Log a message with info priority. The "just so you know" of log levels. 🫶

Parameters

  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

🍓 void log4shib::Category::info (const std::string & message)

Same, with a std::string.

Parameters

  • message — string to write in the log file

✨ CategoryStream log4shib::Category::infoStream () — [inline]

Returns a CategoryStream with priority INFO.

Returns

  • The CategoryStream.

🧚 bool log4shib::Category::isAlertEnabled () const — [inline]

Return true if the Category will log messages with priority ALERT. 🚨

Returns

  • Whether the Category will log.

💜 bool log4shib::Category::isCritEnabled () const — [inline]

Return true if the Category will log messages with priority CRIT.

Returns

  • Whether the Category will log.

🔍 bool log4shib::Category::isDebugEnabled () const — [inline]

Return true if the Category will log messages with priority DEBUG.

Returns

  • Whether the Category will log.

🚨 bool log4shib::Category::isEmergEnabled () const — [inline]

Return true if the Category will log messages with priority EMERG.

Returns

  • Whether the Category will log.

😭 bool log4shib::Category::isErrorEnabled () const — [inline]

Return true if the Category will log messages with priority ERROR.

Returns

  • Whether the Category will log.

💀 bool log4shib::Category::isFatalEnabled () const — [inline]

Return true if the Category will log messages with priority FATAL. NB. priority 'fatal' is equivalent to 'emerg' — yes, again. It's the same girl!! 🔥

Since 0.2.7

Returns

  • Whether the Category will log.

🫶 bool log4shib::Category::isInfoEnabled () const — [inline]

Return true if the Category will log messages with priority INFO.

Returns

  • Whether the Category will log.

🌸 bool log4shib::Category::isNoticeEnabled () const — [inline]

Return true if the Category will log messages with priority NOTICE.

Returns

  • Whether the Category will log.

⭐ bool log4shib::Category::isPriorityEnabled (Priority::Value priority) const — [virtual]

Returns true if the chained priority of the Category is equal to or higher than the given priority. Chained, bestie — the inherited one, not just the local one. 🌳

Parameters

  • priority — The priority to compare with.

Returns

  • whether logging is enable for this priority.

🎀 bool log4shib::Category::isWarnEnabled () const — [inline]

Return true if the Category will log messages with priority WARN. ⚠️

Returns

  • Whether the Category will log.

🔥 void log4shib::Category::log (Priority::Value priority, const char * stringFormat, ...) — [virtual]

Log a message with the specified priority. The general-purpose one — you bring the priority, she brings the logging. 💅

Parameters

  • priority — The priority of this log message.
  • stringFormat — Format specifier for the string to write in the log file.
  • ... — The arguments for stringFormat

🦋 void log4shib::Category::log (Priority::Value priority, const std::string & message) — [virtual]

Log a message with the specified priority, std::string edition.

Parameters

  • priority — The priority of this log message.
  • message — string to write in the log file

💜 void log4shib::Category::logva (Priority::Value priority, const char * stringFormat, va_list va) — [virtual]

Log a message with the specified priority. The va_list one — for when you've already got your args all packed up in a little bag. 🎀

Since 0.2.7

✨ Parameters ✨

  • priority — the priority of this log message, like how urgent it is 💅
  • stringFormat — the format specifier for the string that's gonna get written into the log file
  • va — the args for stringFormat

void log4shib::Category::notice (const char * stringFormat, ...)

Logs a message with notice priority 🎀

Parameters

  • stringFormat — the format specifier for the string that gets written in the log file
  • ... — the arguments for stringFormat

void log4shib::Category::notice (const std::string & message)

Same notice-energy, but you hand it a string 💖

Parameters

  • message — the string to write in the log file

CategoryStream log4shib::Category::noticeStream () [inline]

Hands you back a CategoryStream that's rocking priority NOTICE ⭐

Returns

The CategoryStream, bestie. That's it. That's the return.

CategoryStream log4shib::Category::operator<< (Priority::Value priority) [virtual]

Returns a CategoryStream with whatever Priority you pass in — this one's [virtual], so it's got main character energy 👑

Parameters

  • priority — the Priority of the CategoryStream

Returns

The requested CategoryStream

bool log4shib::Category::ownsAppender () const [inline]

Returns true if the Category owns the first Appender in its Appender set 👀 and if that's the case, the Category destructor is gonna delete that Appender.

Deprecated — use ownsAppender(Appender*) instead. Like, seriously, use the other one 🙈

bool log4shib::Category::ownsAppender (Appender * appender) const [virtual]

Returns true if the Category owns the Appender you passed in. If it does, the Category destructor will delete that Appender 🗑️✨

Since

0.2.7

Reimplemented in log4shib::FixedContextCategory

void log4shib::Category::removeAllAppenders () [virtual]

Removes, like, all the appenders for this Category. Every last one. Gone 💀

Reimplemented in log4shib::FixedContextCategory

void log4shib::Category::removeAppender (Appender * appender) [virtual]

Removes the one specific appender you point at for this Category 🎯

Since

0.2.7

void log4shib::Category::setAdditivity (bool additivity) [virtual]

Sets the additivity flag for this Category instance. Yep, that's the whole vibe 🦋

Reimplemented in log4shib::FixedContextCategory

void log4shib::Category::setAppender (Appender & appender) [inline]

Adds an Appender for this Category — and heads up, this method does not pass ownership from the caller over to the Category 🫶

Deprecated — use addAppender(Appender&) instead.

Parameters

  • appender — the Appender this category has to log to

void log4shib::Category::setAppender (Appender * appender) [inline]

Adds an Appender to this Category — and this version does pass ownership from the caller to the Category 👑

Deprecated — use addAppender(Appender*) or removeAllAppenders() instead.

Parameters

  • appender — the Appender this category has to log to, or NULL to remove the current Appenders

void log4shib::Category::setPriority (Priority::Value priority) [virtual]

Sets the priority of this Category 🌈

Parameters

  • priority — the priority to set. Use Priority::NOTSET to let the category use its parent's priority as its effective priority.

Exceptions

std::invalid_argument — thrown if the caller tries to set Priority::NOTSET on the Root Category. Yeah, don't do that 😭

void log4shib::Category::setRootPriority (Priority::Value priority) [static]

Sets the priority of the root Category, and it's [static] so it's everyone's business 🌸

Parameters

  • priority — the new priority for the root Category

void log4shib::Category::shutdown () [static]

This method will remove all Appenders from Categories.XXX. That's the whole thing, no cap 💅

void log4shib::Category::warn (const char * stringFormat, ...)

Logs a message with warn priority ⚠️✨

Parameters

  • stringFormat — the format specifier for the string that gets written in the log file
  • ... — the arguments for stringFormat

void log4shib::Category::warn (const std::string & message)

Logs a message with warn priority, but the string version 🍓

Parameters

  • message — the string to write in the log file

CategoryStream log4shib::Category::warnStream () [inline]

Returns a CategoryStream with priority WARN — for when you wanna stream your warnings in style 🔥

Returns

The CategoryStream

  • friend class HierarchyMaintainer [friend] — yes, HierarchyMaintainer is a friend of this class. Friendship bracelet secured 🎀

Author

Generated automatically by Doxygen for log4shib from the source code. Not a human, just a very busy little doc generator doing its thing 🤖✨

aaaand that's the whole page, bestie!! 🎉 this last bit came to you courtesy of the manpage footer itself: source is log4shib, Version 2.0.1, and you're reading log4shib::Category(3) — love that for us 💜🦋

📦 where this page comes from