You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4cxx-dev@logging.apache.org by ca...@apache.org on 2008/02/20 05:21:51 UTC
svn commit: r629346 [2/4] - in /logging/log4cxx/trunk: ./ src/assembly/
src/changes/ src/main/cpp/ src/main/include/log4cxx/
src/main/include/log4cxx/config/ src/main/include/log4cxx/filter/
src/main/include/log4cxx/helpers/ src/main/include/log4cxx/ne...
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/logger.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/logger.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/logger.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/logger.h Tue Feb 19 20:21:39 2008
@@ -121,7 +121,7 @@
<p>It is intended to be used by sub-classes only. You should not
create categories directly.
- @param pool, lifetime of pool must be longer than logger.
+ @param pool lifetime of pool must be longer than logger.
@param name The name of the logger.
*/
Logger(log4cxx::helpers::Pool& pool, const LogString& name);
@@ -152,7 +152,9 @@
hierarchy circumventing any evaluation of whether to log or not
to log the particular log request.
- @param event the event to log. */
+ @param event the event to log.
+ @param p memory pool for any allocations needed to process request.
+ */
void callAppenders(const log4cxx::spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p) const;
/**
@@ -162,115 +164,419 @@
void closeNestedAppenders();
/**
- Log a message string with the {@link Level#DEBUG DEBUG} level.
+ Log a message string with the DEBUG level.
<p>This method first checks if this logger is <code>DEBUG</code>
- enabled by comparing the level of this logger with the {@link
- Level#DEBUG DEBUG} level. If this logger is
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
<code>DEBUG</code> enabled, it proceeds to call all the
registered appenders in this logger and also higher in the
hierarchy depending on the value of the additivity flag.
- @param message the message string to log.
- @param file the file where the log statement was written.
- @param line the line where the log statement was written.
+ @param msg the message string to log.
+ @param location location of source of logging request.
*/
void debug(const std::string& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void debug(const std::string& msg) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void debug(const std::wstring& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void debug(const std::wstring& msg) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void debug(const std::basic_string<UniChar>& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void debug(const std::basic_string<UniChar>& msg) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void debug(const CFStringRef& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the DEBUG level.
+
+ <p>This method first checks if this logger is <code>DEBUG</code>
+ enabled by comparing the level of this logger with the
+ DEBUG level. If this logger is
+ <code>DEBUG</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void debug(const CFStringRef& msg) const;
#endif
/**
- Log a message string with the {@link Level#ERROR ERROR} level.
+ Log a message string with the ERROR level.
<p>This method first checks if this logger is <code>ERROR</code>
- enabled by comparing the level of this logger with the {@link
- Level#ERROR ERROR} level. If this logger is
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
<code>ERROR</code> enabled, it proceeds to call all the
registered appenders in this logger and also higher in the
hierarchy depending on the value of the additivity flag.
- @param message the message string to log.
- @param file the file where the log statement was written.
- @param line the line where the log statement was written.
+ @param msg the message string to log.
+ @param location location of source of logging request.
*/
void error(const std::string& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void error(const std::string& msg) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void error(const std::wstring& msg) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void error(const std::wstring& msg, const log4cxx::spi::LocationInfo& location) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void error(const std::basic_string<UniChar>& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void error(const std::basic_string<UniChar>& msg) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void error(const CFStringRef& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void error(const CFStringRef& msg) const;
#endif
/**
- Log a message string with the {@link Level#FATAL FATAL} level.
+ Log a message string with the FATAL level.
<p>This method first checks if this logger is <code>FATAL</code>
- enabled by comparing the level of this logger with the {@link
- Level#FATAL FATAL} level. If this logger is
+ enabled by comparing the level of this logger with the
+ FATAL level. If this logger is
<code>FATAL</code> enabled, it proceeds to call all the
registered appenders in this logger and also higher in the
hierarchy depending on the value of the additivity flag.
- @param message the message string to log.
- @param file the file where the log statement was written.
- @param line the line where the log statement was written.
+ @param msg the message string to log.
+ @param location location of source of logging request.
*/
void fatal(const std::string& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void fatal(const std::string& msg) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void fatal(const std::wstring& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void fatal(const std::wstring& msg) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void fatal(const std::basic_string<UniChar>& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void fatal(const std::basic_string<UniChar>& msg) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void fatal(const CFStringRef& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the ERROR level.
+
+ <p>This method first checks if this logger is <code>ERROR</code>
+ enabled by comparing the level of this logger with the
+ ERROR level. If this logger is
+ <code>ERROR</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void fatal(const CFStringRef& msg) const;
#endif
+
/**
This method creates a new logging event and logs the event
without further checks.
@param level the level to log.
- @param message the message string to log.
- @param location location of the logging statement.
+ @param message message.
+ @param location location of source of logging request.
*/
void forcedLog(const LevelPtr& level, const std::string& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ */
void forcedLog(const LevelPtr& level, const std::string& message) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ @param location location of source of logging request.
+ */
void forcedLog(const LevelPtr& level, const std::wstring& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ */
void forcedLog(const LevelPtr& level, const std::wstring& message) const;
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_CFSTRING_API
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ @param location location of source of logging request.
+ */
void forcedLog(const LevelPtr& level, const std::basic_string<UniChar>& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ */
void forcedLog(const LevelPtr& level, const std::basic_string<UniChar>& message) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ @param location location of source of logging request.
+ */
void forcedLog(const LevelPtr& level, const CFStringRef& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This method creates a new logging event and logs the event
+ without further checks.
+ @param level the level to log.
+ @param message message.
+ */
void forcedLog(const LevelPtr& level, const CFStringRef& message) const;
#endif
/**
@@ -320,16 +626,34 @@
/**
- Return the logger name. */
+ * Get the logger name.
+ * @return logger name as LogString.
+ */
const LogString getName() const { return name; }
+ /**
+ * Get logger name in current encoding.
+ * @param name buffer to which name is appended.
+ */
void getName(std::string& name) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ * Get logger name.
+ * @param name buffer to which name is appended.
+ */
void getName(std::wstring& name) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ * Get logger name.
+ * @param name buffer to which name is appended.
+ */
void getName(std::basic_string<UniChar>& name) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ * Get logger name.
+ * @param name buffer to which name is appended.
+ */
void getName(CFStringRef& name) const;
#endif
@@ -350,20 +674,45 @@
LevelPtr getLevel() const;
/**
- Retrieve a logger by name.
+ * Retrieve a logger by name in current encoding.
+ * @param name logger name.
*/
static LoggerPtr getLogger(const std::string& name);
+ /**
+ * Retrieve a logger by name in current encoding.
+ * @param name logger name.
+ */
static LoggerPtr getLogger(const char* const name);
#if LOG4CXX_WCHAR_T_API
+ /**
+ * Retrieve a logger by name.
+ * @param name logger name.
+ */
static LoggerPtr getLogger(const std::wstring& name);
+ /**
+ * Retrieve a logger by name.
+ * @param name logger name.
+ */
static LoggerPtr getLogger(const wchar_t* const name);
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ * Retrieve a logger by name.
+ * @param name logger name.
+ */
static LoggerPtr getLogger(const std::basic_string<UniChar>& name);
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ * Retrieve a logger by name.
+ * @param name logger name.
+ */
static LoggerPtr getLogger(const CFStringRef& name);
#endif
+ /**
+ * Retrieve a logger by name in Unicode.
+ * @param name logger name.
+ */
static LoggerPtr getLoggerLS(const LogString& name);
/**
@@ -386,21 +735,73 @@
*/
static LoggerPtr getLoggerLS(const LogString& name,
const log4cxx::spi::LoggerFactoryPtr& factory);
+ /**
+ Like #getLogger except that the type of logger
+ instantiated depends on the type returned by the
+ LoggerFactory#makeNewLoggerInstance method of the
+ <code>factory</code> parameter.
+
+ <p>This method is intended to be used by sub-classes.
+
+ @param name The name of the logger to retrieve.
+
+ @param factory A LoggerFactory implementation that will
+ actually create a new Instance.
+ */
static LoggerPtr getLogger(const std::string& name,
const log4cxx::spi::LoggerFactoryPtr& factory);
#if LOG4CXX_WCHAR_T_API
- static LoggerPtr getLogger(const std::wstring& name,
- const log4cxx::spi::LoggerFactoryPtr& factory);
-#endif
-#if LOG4CXX_UNICHAR_API
- static LoggerPtr getLogger(const std::basic_string<UniChar>& name,
- const log4cxx::spi::LoggerFactoryPtr& factory);
-#endif
-#if LOG4CXX_CFSTRING_API
- static LoggerPtr getLogger(const CFStringRef& name,
- const log4cxx::spi::LoggerFactoryPtr& factory);
-#endif
-
+ /**
+ Like #getLogger except that the type of logger
+ instantiated depends on the type returned by the
+ LoggerFactory#makeNewLoggerInstance method of the
+ <code>factory</code> parameter.
+
+ <p>This method is intended to be used by sub-classes.
+
+ @param name The name of the logger to retrieve.
+
+ @param factory A LoggerFactory implementation that will
+ actually create a new Instance.
+ */
+ static LoggerPtr getLogger(const std::wstring& name,
+ const log4cxx::spi::LoggerFactoryPtr& factory);
+#endif
+#if LOG4CXX_UNICHAR_API
+ /**
+ Like #getLogger except that the type of logger
+ instantiated depends on the type returned by the
+ LoggerFactory#makeNewLoggerInstance method of the
+ <code>factory</code> parameter.
+
+ <p>This method is intended to be used by sub-classes.
+
+ @param name The name of the logger to retrieve.
+
+ @param factory A LoggerFactory implementation that will
+ actually create a new Instance.
+ */
+ static LoggerPtr getLogger(const std::basic_string<UniChar>& name,
+ const log4cxx::spi::LoggerFactoryPtr& factory);
+#endif
+#if LOG4CXX_CFSTRING_API
+ /**
+ Like #getLogger except that the type of logger
+ instantiated depends on the type returned by the
+ LoggerFactory#makeNewLoggerInstance method of the
+ <code>factory</code> parameter.
+
+ <p>This method is intended to be used by sub-classes.
+
+ @param name The name of the logger to retrieve.
+
+ @param factory A LoggerFactory implementation that will
+ actually create a new Instance.
+ */
+ static LoggerPtr getLogger(const CFStringRef& name,
+ const log4cxx::spi::LoggerFactoryPtr& factory);
+#endif
+
/**
Return the <em>inherited</em> ResourceBundle for this logger.
@@ -426,31 +827,105 @@
public:
/**
- Log a message string with the {@link Level#INFO INFO} level.
+ Log a message string with the INFO level.
<p>This method first checks if this logger is <code>INFO</code>
- enabled by comparing the level of this logger with the {@link
- Level#INFO INFO} level. If this logger is
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
<code>INFO</code> enabled, it proceeds to call all the
registered appenders in this logger and also higher in the
hierarchy depending on the value of the additivity flag.
- @param message the message string to log.
- @param file the file where the log statement was written.
- @param line the line where the log statement was written.
+ @param msg the message string to log.
+ @param location location of source of logging request.
*/
void info(const std::string& msg, const log4cxx::spi::LocationInfo& location) const;
void info(const std::string& msg) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ Log a message string with the INFO level.
+
+ <p>This method first checks if this logger is <code>INFO</code>
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
+ <code>INFO</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void info(const std::wstring& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the INFO level.
+
+ <p>This method first checks if this logger is <code>INFO</code>
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
+ <code>INFO</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void info(const std::wstring& msg) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a message string with the INFO level.
+
+ <p>This method first checks if this logger is <code>INFO</code>
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
+ <code>INFO</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void info(const std::basic_string<UniChar>& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the INFO level.
+
+ <p>This method first checks if this logger is <code>INFO</code>
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
+ <code>INFO</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void info(const std::basic_string<UniChar>& msg) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a message string with the INFO level.
+
+ <p>This method first checks if this logger is <code>INFO</code>
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
+ <code>INFO</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void info(const CFStringRef& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the INFO level.
+
+ <p>This method first checks if this logger is <code>INFO</code>
+ enabled by comparing the level of this logger with the
+ INFO level. If this logger is
+ <code>INFO</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void info(const CFStringRef& msg) const;
#endif
@@ -570,54 +1045,302 @@
void l7dlog(const LevelPtr& level, const LogString& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::vector<LogString>& values) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::string& key,
const log4cxx::spi::LocationInfo& locationInfo) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The first value for the placeholders within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::string& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::string& val1) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The first value for the placeholders within the pattern.
+ @param val2 The second value for the placeholders within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::string& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::string& val1, const std::string& val2) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+ @param val3 The value for the third placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::string& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::string& val1, const std::string& val2, const std::string& val3) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::wstring& key,
const log4cxx::spi::LocationInfo& locationInfo) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::wstring& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::wstring& val1) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::wstring& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::wstring& val1, const std::wstring& val2) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+ @param val3 The value for the third placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::wstring& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::wstring& val1, const std::wstring& val2, const std::wstring& val3) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::basic_string<UniChar>& key,
const log4cxx::spi::LocationInfo& locationInfo) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::basic_string<UniChar>& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::basic_string<UniChar>& val1) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::basic_string<UniChar>& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::basic_string<UniChar>& val1, const std::basic_string<UniChar>& val2) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+ @param val3 The value for the third placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const std::basic_string<UniChar>& key,
const log4cxx::spi::LocationInfo& locationInfo,
const std::basic_string<UniChar>& val1, const std::basic_string<UniChar>& val2,
const std::basic_string<UniChar>& val3) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const CFStringRef& key,
const log4cxx::spi::LocationInfo& locationInfo) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const CFStringRef& key,
const log4cxx::spi::LocationInfo& locationInfo,
const CFStringRef& val1) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const CFStringRef& key,
const log4cxx::spi::LocationInfo& locationInfo,
const CFStringRef& val1, const CFStringRef& val2) const;
+ /**
+ Log a localized and parameterized message.
+
+ First, the user supplied
+ <code>key</code> is searched in the resource bundle. Next, the resulting
+ pattern is formatted using helpers::StringHelper::format method with the user
+ supplied string array <code>params</code>.
+
+ @param level The level of the logging request.
+ @param key The key to be searched in the #ResourceBundle.
+ @param locationInfo The location info of the logging request.
+ @param val1 The value for the first placeholder within the pattern.
+ @param val2 The value for the second placeholder within the pattern.
+ @param val3 The value for the third placeholder within the pattern.
+
+ @see #setResourceBundle
+ */
void l7dlog(const LevelPtr& level, const CFStringRef& key,
const log4cxx::spi::LocationInfo& locationInfo,
const CFStringRef& val1, const CFStringRef& val2,
@@ -633,22 +1356,78 @@
@param location The source file of the logging request, may be null. */
void log(const LevelPtr& level, const std::string& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ */
void log(const LevelPtr& level, const std::string& message) const;
#if LOG4CXX_WCHAR_T_API
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ @param location The source file of the logging request, may be null. */
void log(const LevelPtr& level, const std::wstring& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ */
void log(const LevelPtr& level, const std::wstring& message) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ @param location The source file of the logging request, may be null. */
void log(const LevelPtr& level, const std::basic_string<UniChar>& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ */
void log(const LevelPtr& level, const std::basic_string<UniChar>& message) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ @param location The source file of the logging request, may be null. */
void log(const LevelPtr& level, const CFStringRef& message,
const log4cxx::spi::LocationInfo& location) const;
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ */
void log(const LevelPtr& level, const CFStringRef& message) const;
#endif
+ /**
+ This is the most generic printing method. It is intended to be
+ invoked by <b>wrapper</b> classes.
+
+ @param level The level of the logging request.
+ @param message The message of the logging request.
+ @param location The source file of the logging request, may be null. */
void logLS(const LevelPtr& level, const LogString& message,
const log4cxx::spi::LocationInfo& location) const;
@@ -698,62 +1477,234 @@
inline void setResourceBundle(const helpers::ResourceBundlePtr& bundle)
{ resourceBundle = bundle; }
+#if LOG4CXX_WCHAR_T_API
/**
- Log a message string with the {@link Level#WARN WARN} level.
+ Log a message string with the WARN level.
<p>This method first checks if this logger is <code>WARN</code>
- enabled by comparing the level of this logger with the {@link
- Level#WARN WARN} level. If this logger is
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
<code>WARN</code> enabled, it proceeds to call all the
registered appenders in this logger and also higher in the
hierarchy depending on the value of the additivity flag.
- @param message the message string to log.
- @param file the file where the log statement was written.
- @param line the line where the log statement was written.
+ @param msg the message string to log.
+ @param location location of source of logging request.
*/
-#if LOG4CXX_WCHAR_T_API
void warn(const std::wstring& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void warn(const std::wstring& msg) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void warn(const std::basic_string<UniChar>& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void warn(const std::basic_string<UniChar>& msg) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void warn(const CFStringRef& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void warn(const CFStringRef& msg) const;
#endif
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void warn(const std::string& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the WARN level.
+
+ <p>This method first checks if this logger is <code>WARN</code>
+ enabled by comparing the level of this logger with the
+ WARN level. If this logger is
+ <code>WARN</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void warn(const std::string& msg) const;
+#if LOG4CXX_WCHAR_T_API
/**
- Log a message string with the {@link Level#TRACE TRACE} level.
+ Log a message string with the TRACE level.
<p>This method first checks if this logger is <code>TRACE</code>
- enabled by comparing the level of this logger with the {@link
- Level#TRACE TRACE} level. If this logger is
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
<code>TRACE</code> enabled, it proceeds to call all the
registered appenders in this logger and also higher in the
hierarchy depending on the value of the additivity flag.
- @param message the message string to log.
- @param file the file where the log statement was written.
- @param line the line where the log statement was written.
+ @param msg the message string to log.
+ @param location location of source of logging request.
*/
-#if LOG4CXX_WCHAR_T_API
void trace(const std::wstring& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void trace(const std::wstring& msg) const;
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void trace(const std::basic_string<UniChar>& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void trace(const std::basic_string<UniChar>& msg) const;
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void trace(const CFStringRef& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void trace(const CFStringRef& msg) const;
#endif
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ @param location location of source of logging request.
+ */
void trace(const std::string& msg, const log4cxx::spi::LocationInfo& location) const;
+ /**
+ Log a message string with the TRACE level.
+
+ <p>This method first checks if this logger is <code>TRACE</code>
+ enabled by comparing the level of this logger with the
+ TRACE level. If this logger is
+ <code>TRACE</code> enabled, it proceeds to call all the
+ registered appenders in this logger and also higher in the
+ hierarchy depending on the value of the additivity flag.
+
+ @param msg the message string to log.
+ */
void trace(const std::string& msg) const;
inline const log4cxx::helpers::Mutex& getMutex() const { return mutex; }
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h Tue Feb 19 20:21:39 2008
@@ -74,41 +74,112 @@
/**
Retrieve the appropriate Logger instance.
+ * @param name logger name in current encoding.
+ * @return logger.
*/
static LoggerPtr getLogger(const std::string& name);
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name in current encoding.
+ * @param factory logger factory.
+ * @return logger.
+ */
static LoggerPtr getLogger(const std::string& name,
const spi::LoggerFactoryPtr& factory);
+ /**
+ * Determines if logger name exists in the hierarchy.
+ * @param name logger name.
+ * @return true if logger exists.
+ */
static LoggerPtr exists(const std::string& name);
#if LOG4CXX_WCHAR_T_API
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @return logger.
+ */
static LoggerPtr getLogger(const std::wstring& name);
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @param factory logger factory.
+ * @return logger.
+ */
static LoggerPtr getLogger(const std::wstring& name,
const spi::LoggerFactoryPtr& factory);
+ /**
+ * Determines if logger name exists in the hierarchy.
+ * @param name logger name.
+ * @return true if logger exists.
+ */
static LoggerPtr exists(const std::wstring& name);
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @return logger.
+ */
static LoggerPtr getLogger(const std::basic_string<UniChar>& name);
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @param factory logger factory.
+ * @return logger.
+ */
static LoggerPtr getLogger(const std::basic_string<UniChar>& name,
const spi::LoggerFactoryPtr& factory);
+ /**
+ * Determines if logger name exists in the hierarchy.
+ * @param name logger name.
+ * @return true if logger exists.
+ */
static LoggerPtr exists(const std::basic_string<UniChar>& name);
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @return logger.
+ */
static LoggerPtr getLogger(const CFStringRef& name);
+ /**
+ Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @param factory logger factory.
+ * @return logger.
+ */
static LoggerPtr getLogger(const CFStringRef& name,
const spi::LoggerFactoryPtr& factory);
+ /**
+ * Determines if logger name exists in the hierarchy.
+ * @param name logger name.
+ * @return true if logger exists.
+ */
static LoggerPtr exists(const CFStringRef& name);
#endif
/**
Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @return logger.
*/
static LoggerPtr getLoggerLS(const LogString& name);
/**
Retrieve the appropriate Logger instance.
+ * @param name logger name.
+ * @param factory logger factory.
+ * @return logger.
*/
static LoggerPtr getLoggerLS(const LogString& name,
const spi::LoggerFactoryPtr& factory);
+ /**
+ * Determines if logger name exists in the hierarchy.
+ * @param name logger name.
+ * @return true if logger exists.
+ */
static LoggerPtr existsLS(const LogString& name);
static LoggerList getCurrentLoggers();
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h Tue Feb 19 20:21:39 2008
@@ -66,14 +66,26 @@
*
* <p>If the current thread does not have a context map it is
* created as a side effect.
- * */
+ * @param key key
+ * @param value value.
+ */
static void put(const std::string& key, const std::string& value);
+ /**
+ * Put a context value (the <code>o</code> parameter) as identified
+ * with the <code>key</code> parameter into the current thread's
+ * context map.
+ *
+ * <p>If the current thread does not have a context map it is
+ * created as a side effect.
+ * */
static void putLS(const LogString& key, const LogString& value);
/**
* Get the context identified by the <code>key</code> parameter.
*
* <p>This method has no side effects.
+ * @param key key.
+ * @return value for key, empty if not set.
* */
static std::string get(const std::string& key);
/**
@@ -86,26 +98,126 @@
/**
* Remove the the context identified by the <code>key</code>
- * parameter. */
+ * parameter.
+ * @param key key.
+ * @return value if key had been set, empty if not.
+ */
static std::string remove(const std::string& key);
#if LOG4CXX_WCHAR_T_API
+ /**
+ * Places a key/value pair in the MDC for the current thread
+ * which will be removed during the corresponding destructor. Both
+ * construction and destruction are expected to be on the same thread.
+ * @param key key
+ * @param value value.
+ */
MDC(const std::wstring& key, const std::wstring& value);
+ /**
+ * Put a context value (the <code>o</code> parameter) as identified
+ * with the <code>key</code> parameter into the current thread's
+ * context map.
+ *
+ * <p>If the current thread does not have a context map it is
+ * created as a side effect.
+ * @param key key
+ * @param value value.
+ */
static void put(const std::wstring& key, const std::wstring& value);
+ /**
+ * Get the context identified by the <code>key</code> parameter.
+ *
+ * <p>This method has no side effects.
+ * @param key key.
+ * @return value for key, empty if not set.
+ * */
static std::wstring get(const std::wstring& key);
+ /**
+ * Remove the the context identified by the <code>key</code>
+ * parameter.
+ * @param key key.
+ * @return value if key had been set, empty if not.
+ */
static std::wstring remove(const std::wstring& key);
#endif
#if LOG4CXX_UNICHAR_API
+ /**
+ * Places a key/value pair in the MDC for the current thread
+ * which will be removed during the corresponding destructor. Both
+ * construction and destruction are expected to be on the same thread.
+ * @param key key
+ * @param value value.
+ */
MDC(const std::basic_string<UniChar>& key, const std::basic_string<UniChar>& value);
+ /**
+ * Put a context value (the <code>o</code> parameter) as identified
+ * with the <code>key</code> parameter into the current thread's
+ * context map.
+ *
+ * <p>If the current thread does not have a context map it is
+ * created as a side effect.
+ * @param key key
+ * @param value value.
+ */
static void put(const std::basic_string<UniChar>& key, const std::basic_string<UniChar>& value);
+ /**
+ * Get the context identified by the <code>key</code> parameter.
+ *
+ * <p>This method has no side effects.
+ * @param key key.
+ * @return value for key, empty if not set.
+ * */
static std::basic_string<UniChar> get(const std::basic_string<UniChar>& key);
+ /**
+ * Remove the the context identified by the <code>key</code>
+ * parameter.
+ * @param key key.
+ * @return value if key had been set, empty if not.
+ */
static std::basic_string<UniChar> remove(const std::basic_string<UniChar>& key);
#endif
#if LOG4CXX_CFSTRING_API
+ /**
+ * Places a key/value pair in the MDC for the current thread
+ * which will be removed during the corresponding destructor. Both
+ * construction and destruction are expected to be on the same thread.
+ * @param key key
+ * @param value value.
+ */
MDC(const CFStringRef& key, const CFStringRef& value);
+ /**
+ * Put a context value (the <code>o</code> parameter) as identified
+ * with the <code>key</code> parameter into the current thread's
+ * context map.
+ *
+ * <p>If the current thread does not have a context map it is
+ * created as a side effect.
+ * @param key key
+ * @param value value.
+ */
static void put(const CFStringRef& key, const CFStringRef& value);
+ /**
+ * Get the context identified by the <code>key</code> parameter.
+ *
+ * <p>This method has no side effects.
+ * @param key key.
+ * @return value for key, empty if not set.
+ * */
static CFStringRef get(const CFStringRef& key);
+ /**
+ * Remove the the context identified by the <code>key</code>
+ * parameter.
+ * @param key key.
+ * @return value if key had been set, empty if not.
+ */
static CFStringRef remove(const CFStringRef& key);
#endif
+ /**
+ * Remove the the context identified by the <code>key</code>
+ * parameter.
+ * @param key key.
+ * @param prevValue buffer to which previous value is appended.
+ * @return true if key existed in MDC.
+ */
static bool remove(const LogString& key, LogString& prevValue);
/**
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h Tue Feb 19 20:21:39 2008
@@ -157,14 +157,16 @@
static bool empty();
/**
- Clients should call this method before leaving a diagnostic
- context.
- <p>The returned value is the value that was pushed last. If no
- context is available, then the empty string "" is returned.
- @return The innermost diagnostic context.
+ Pop top value off stack.
+ @return top value.
*/
static LogString pop();
- static bool pop(std::string&);
+ /**
+ Pop top value off stack.
+ @param buf to which top value is appended.
+ @return true if NDC contained at least one value.
+ */
+ static bool pop(std::string& buf);
/**
Looks at the last diagnostic context at the top of this NDC
@@ -174,7 +176,12 @@
@return String The innermost diagnostic context.
*/
static LogString peek();
- static bool peek(std::string&);
+ /**
+ Get top value without removing value.
+ @param buf to which top value is appended.
+ @return true if NDC contained at least one value.
+ */
+ static bool peek(std::string& buf);
/**
Push new diagnostic context information for the current thread.
@@ -183,6 +190,12 @@
@param message The new diagnostic context information.
*/
static void push(const std::string& message);
+ /**
+ Push new diagnostic context information for the current thread.
+ <p>The contents of the <code>message</code> parameter is
+ determined solely by the client.
+ @param message The new diagnostic context information.
+ */
static void pushLS(const LogString& message);
/**
@@ -204,8 +217,26 @@
static void remove();
#if LOG4CXX_WCHAR_T_API
- NDC(const std::wstring& message);
- static void push(const std::wstring& message);
+ /**
+ Creates a nested diagnostic context.
+ Since java performs no automatic cleanup of objects when a
+ scope is left, in log4j push() and pop() must be used
+ to manage the NDC. For convenience, log4cxx provides
+ an NDC constructor and destructor which simply call the push() and
+ pop() methods, allowing for automatic cleanup when the current
+ scope ends.
+
+ @param message The new diagnostic context information.
+ @see The #push method.
+ */
+ NDC(const std::wstring& message);
+ /**
+ Push new diagnostic context information for the current thread.
+ <p>The contents of the <code>message</code> parameter is
+ determined solely by the client.
+ @param message The new diagnostic context information.
+ */
+ static void push(const std::wstring& message);
/**
* Appends the current NDC content to the provided string.
* @param dst destination.
@@ -220,7 +251,25 @@
static bool pop(std::wstring& dst);
#endif
#if LOG4CXX_UNICHAR_API
- NDC(const std::basic_string<UniChar>& message);
+ /**
+ Creates a nested diagnostic context.
+ Since java performs no automatic cleanup of objects when a
+ scope is left, in log4j push() and pop() must be used
+ to manage the NDC. For convenience, log4cxx provides
+ an NDC constructor and destructor which simply call the push() and
+ pop() methods, allowing for automatic cleanup when the current
+ scope ends.
+
+ @param message The new diagnostic context information.
+ @see The #push method.
+ */
+ NDC(const std::basic_string<UniChar>& message);
+ /**
+ Push new diagnostic context information for the current thread.
+ <p>The contents of the <code>message</code> parameter is
+ determined solely by the client.
+ @param message The new diagnostic context information.
+ */
static void push(const std::basic_string<UniChar>& message);
/**
* Appends the current NDC content to the provided string.
@@ -236,7 +285,25 @@
static bool pop(std::basic_string<UniChar>& dst);
#endif
#if LOG4CXX_CFSTRING_API
- NDC(const CFStringRef& message);
+ /**
+ Creates a nested diagnostic context.
+ Since java performs no automatic cleanup of objects when a
+ scope is left, in log4j push() and pop() must be used
+ to manage the NDC. For convenience, log4cxx provides
+ an NDC constructor and destructor which simply call the push() and
+ pop() methods, allowing for automatic cleanup when the current
+ scope ends.
+
+ @param message The new diagnostic context information.
+ @see The #push method.
+ */
+ NDC(const CFStringRef& message);
+ /**
+ Push new diagnostic context information for the current thread.
+ <p>The contents of the <code>message</code> parameter is
+ determined solely by the client.
+ @param message The new diagnostic context information.
+ */
static void push(const CFStringRef& message);
/**
* Gets the current NDC value.
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h Tue Feb 19 20:21:39 2008
@@ -28,18 +28,18 @@
/**
Sends {@link spi::LoggingEvent LoggingEvent} objects to a remote a log server,
- usually a {@link net::SocketNode SocketNode}.
+ usually Apache Chainsaw.
<p>The SocketAppender has the following properties:
- - If sent to a {@link net::SocketNode SocketNode}, remote logging
+ - If sent to Apache Chainsaw, remote logging
is non-intrusive as far as the log event is concerned. In other
words, the event will be logged with the same time stamp, {@link
NDC NDC}, location info as if it were logged locally by
the client.
- SocketAppenders do not use a layout. They ship a
- serialized {@link spi::LoggingEvent LoggingEvent} object
+ serialized {@link log4cxx::spi::LoggingEvent LoggingEvent} object
to the server side.
- Remote logging uses the TCP protocol. Consequently, if
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappenderskeleton.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappenderskeleton.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappenderskeleton.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappenderskeleton.h Tue Feb 19 20:21:39 2008
@@ -82,7 +82,7 @@
/**
* The <b>RemoteHost</b> option takes a string value which should be
* the host name of the server where a
- * {@link net::SocketNode SocketNode} is running.
+ * Apache Chainsaw or compatible is running.
* */
inline void setRemoteHost(const LogString& host)
{ address = helpers::InetAddress::getByName(host);
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/classnamepatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/classnamepatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/classnamepatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/classnamepatternconverter.h Tue Feb 19 20:21:39 2008
@@ -50,17 +50,11 @@
/**
* Gets an instance of ClassNamePatternConverter.
* @param options options, may be null.
- * @param logger logger for diagnostic messages, may be null.
* @return instance of pattern converter.
*/
static PatternConverterPtr newInstance(
const std::vector<LogString>& options);
- /**
- * Format a logging event.
- * @param event event to format.
- * @param toAppendTo string buffer to which class name will be appended.
- */
void format(const log4cxx::spi::LoggingEventPtr&event,
LogString& toAppendTo,
log4cxx::helpers::Pool& p) const;
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/datepatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/datepatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/datepatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/datepatternconverter.h Tue Feb 19 20:21:39 2008
@@ -46,13 +46,12 @@
*/
DatePatternConverter(const OptionsList& options);
- static log4cxx::helpers::DateFormatPtr getDateFormat(const OptionsList& options);
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
- * @param logger logger, current ignored, may be null.
* @return instance of pattern converter.
*/
+ static log4cxx::helpers::DateFormatPtr getDateFormat(const OptionsList& options);
public:
DECLARE_LOG4CXX_PATTERN(DatePatternConverter)
BEGIN_LOG4CXX_CAST_MAP()
@@ -63,24 +62,13 @@
static PatternConverterPtr newInstance(
const std::vector<LogString>& options);
- /**
- * {@inheritDoc}
- */
void format(const log4cxx::spi::LoggingEventPtr& event,
LogString& output,
log4cxx::helpers::Pool& p) const;
- /**
- * {@inheritDoc}
- */
void format(const log4cxx::helpers::ObjectPtr& obj,
LogString& output,
log4cxx::helpers::Pool& p) const;
- /**
- * Append formatted date to string buffer.
- * @param date date
- * @param toAppendTo buffer to which formatted date is appended.
- */
void format(const log4cxx::helpers::DatePtr& date,
LogString& toAppendTo,
log4cxx::helpers::Pool& p) const;
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filedatepatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filedatepatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filedatepatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filedatepatternconverter.h Tue Feb 19 20:21:39 2008
@@ -41,7 +41,6 @@
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
- * @param logger logger, current ignored, may be null.
* @return instance of pattern converter.
*/
static PatternConverterPtr newInstance(
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filelocationpatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filelocationpatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filelocationpatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filelocationpatternconverter.h Tue Feb 19 20:21:39 2008
@@ -47,17 +47,13 @@
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
- * @param logger logger, current ignored, may be null.
* @return instance of pattern converter.
*/
static PatternConverterPtr newInstance(
const std::vector<LogString>& options);
- /**
- * {@inheritDoc}
- */
void format(const log4cxx::spi::LoggingEventPtr& event,
- LogString& output,
+ LogString& toAppendTo,
log4cxx::helpers::Pool& p) const;
};
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/fulllocationpatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/fulllocationpatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/fulllocationpatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/fulllocationpatternconverter.h Tue Feb 19 20:21:39 2008
@@ -47,17 +47,13 @@
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
- * @param logger logger, current ignored, may be null.
* @return instance of pattern converter.
*/
static PatternConverterPtr newInstance(
const std::vector<LogString>& options);
- /**
- * {@inheritDoc}
- */
void format(const log4cxx::spi::LoggingEventPtr& event,
- LogString& output,
+ LogString& toAppendTo,
log4cxx::helpers::Pool& p) const;
};
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/integerpatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/integerpatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/integerpatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/integerpatternconverter.h Tue Feb 19 20:21:39 2008
@@ -46,15 +46,11 @@
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
- * @param logger logger, current ignored, may be null.
* @return instance of pattern converter.
*/
static PatternConverterPtr newInstance(
const std::vector<LogString>& options);
- /**
- * {@inheritDoc}
- */
void format(const log4cxx::helpers::ObjectPtr& obj,
LogString& toAppendTo,
log4cxx::helpers::Pool& p) const;
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/levelpatternconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/levelpatternconverter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/levelpatternconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/levelpatternconverter.h Tue Feb 19 20:21:39 2008
@@ -45,22 +45,15 @@
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
- * @param logger logger, current ignored, may be null.
* @return instance of pattern converter.
*/
static PatternConverterPtr newInstance(
const std::vector<LogString>& options);
- /**
- * {@inheritDoc}
- */
void format(const log4cxx::spi::LoggingEventPtr& event,
- LogString& output,
+ LogString& toAppendTo,
log4cxx::helpers::Pool& p) const;
- /**
- * {@inheritDoc}
- */
LogString getStyleClass(const log4cxx::helpers::ObjectPtr& e) const;
};
}