blob: e405ecb96f8ec5854dd78d30462f53b963cc1e37 [file] [log] [blame]
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../../lib/index.js"></script><script type="text/javascript" src="../../../../../index.js"></script><script type="text/javascript" src="../../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.org" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="org"></a><a id="org:org"></a> <span class="permalink"><a href="../../../../../org/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">org</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="org.apache" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="apache"></a><a id="apache:apache"></a> <span class="permalink"><a href="../../../../../org/apache/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">apache</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="org" id="org" class="extype">org</a></dd></dl></div></li><li class="indented3 " name="org.apache.logging" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="logging"></a><a id="logging:logging"></a> <span class="permalink"><a href="../../../../../org/apache/logging/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">logging</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="org.apache" id="org.apache" class="extype">apache</a></dd></dl></div></li><li class="indented4 " name="org.apache.logging.log4j" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="log4j"></a><a id="log4j:log4j"></a> <span class="permalink"><a href="../../../../../org/apache/logging/log4j/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">log4j</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="org.apache.logging" id="org.apache.logging" class="extype">logging</a></dd></dl></div></li><li class="indented5 current" name="org.apache.logging.log4j.scala" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="scala"></a><a id="scala:scala"></a> <span class="permalink"><a href="../../../../../org/apache/logging/log4j/scala/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">scala</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="org.apache.logging.log4j" id="org.apache.logging.log4j" class="extype">log4j</a></dd></dl></div></li><li class="current-entities indented5"><a href="Logger$.html" title="Factory for Loggers." class="object"></a> <a href="Logger.html" title="Scala wrapper for the Log4j Logger interface." class="class"></a><a href="Logger.html" title="Scala wrapper for the Log4j Logger interface.">Logger</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="Logging.html" title="Mix in this trait into classes from which you want to log, give you a logger value with a Logger named according to the class." class="trait"></a><a href="Logging.html" title="Mix in this trait into classes from which you want to log, give you a logger value with a Logger named according to the class.">Logging</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="LoggingContext$.html" title="Manages the context data (context map, MDC) that is added to log events." class="object"></a><a href="LoggingContext$.html" title="Manages the context data (context map, MDC) that is added to log events.">LoggingContext</a></li></ul></div></div><div id="content"><body class="package value"><div id="definition"><div class="big-circle package">p</div><p id="owner"><a href="../../../../index.html" name="org" id="org" class="extype">org</a>.<a href="../../../index.html" name="org.apache" id="org.apache" class="extype">apache</a>.<a href="../../index.html" name="org.apache.logging" id="org.apache.logging" class="extype">logging</a>.<a href="../index.html" name="org.apache.logging.log4j" id="org.apache.logging.log4j" class="extype">log4j</a></p><h1>scala<span class="permalink"><a href="../../../../../org/apache/logging/log4j/scala/index.html" title="Permalink"><i class="material-icons"></i></a></span></h1></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">scala</span></span></h4><div id="comment" class="fullcommenttop"></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="org.apache.logging.log4j.scala.Logger" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoggerextendsAnyVal"></a><a id="Logger:Logger"></a> <span class="permalink"><a href="../../../../../org/apache/logging/log4j/scala/Logger.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">class</span></span> <span class="symbol"><a href="Logger.html" title="Scala wrapper for the Log4j Logger interface."><span class="name">Logger</span></a><span class="result"> extends <span name="scala.AnyVal" class="extype">AnyVal</span></span></span><p class="shortcomment cmt">Scala wrapper for the Log4j <code>Logger</code> interface.</p><div class="fullcomment"><div class="comment cmt"><p>Scala wrapper for the Log4j <code>Logger</code> interface.</p><p>Frequently the purpose of logging is to provide information about what is happening in the system,
which requires including information about the objects being manipulated. In Scala, you can use
<a href="http://docs.scala-lang.org/overviews/core/string-interpolation.html" target="_blank">string interpolation</a>
to achieve this:</p><pre>logger.debug(s<span class="lit">"Logging in user ${user.getName} with birthday ${user.calcBirthday}"</span>)</pre><p>Since this wrapper is implemented with macros, the String construction and method invocations
will only occur when debug logging is enabled.
</p></div></div></li><li class="indented0 " name="org.apache.logging.log4j.scala.Logging" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="LoggingextendsAnyRef"></a><a id="Logging:Logging"></a> <span class="permalink"><a href="../../../../../org/apache/logging/log4j/scala/Logging.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="Logging.html" title="Mix in this trait into classes from which you want to log, give you a logger value with a Logger named according to the class."><span class="name">Logging</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Mix in this trait into classes from which you want to log,
give you a <code>logger</code> value with a <a href="Logger.html" name="org.apache.logging.log4j.scala.Logger" id="org.apache.logging.log4j.scala.Logger" class="extype">Logger</a> named according to the class.</p></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="org.apache.logging.log4j.scala.Logger" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Logger"></a><a id="Logger:Logger"></a> <span class="permalink"><a href="../../../../../org/apache/logging/log4j/scala/Logger$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="Logger$.html" title="Factory for Loggers."><span class="name">Logger</span></a></span><p class="shortcomment cmt">Factory for <a href="Logger.html" name="org.apache.logging.log4j.scala.Logger" id="org.apache.logging.log4j.scala.Logger" class="extype">Logger</a>s.</p><div class="fullcomment"><div class="comment cmt"><p>Factory for <a href="Logger.html" name="org.apache.logging.log4j.scala.Logger" id="org.apache.logging.log4j.scala.Logger" class="extype">Logger</a>s.</p><p>The <a href="Logging.html" name="org.apache.logging.log4j.scala.Logging" id="org.apache.logging.log4j.scala.Logging" class="extype">Logging</a> trait provides a simple way to get a properly named logger into a class.
</p></div></div></li><li class="indented0 " name="org.apache.logging.log4j.scala.LoggingContext" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoggingContext"></a><a id="LoggingContext:LoggingContext"></a> <span class="permalink"><a href="../../../../../org/apache/logging/log4j/scala/LoggingContext$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="LoggingContext$.html" title="Manages the context data (context map, MDC) that is added to log events."><span class="name">LoggingContext</span></a><span class="result"> extends <span name="scala.collection.mutable.Map" class="extype">Map</span>[<span name="scala.Predef.String" class="extype">String</span>, <span name="scala.Predef.String" class="extype">String</span>]</span></span><p class="shortcomment cmt">Manages the context data (context map, MDC) that is added to log events.</p><div class="fullcomment"><div class="comment cmt"><p>Manages the context data (context map, MDC) that is added to log events.</p><p>A wrapper around <code>org.apache.logging.log4j.ThreadContext</code>.
</p></div></div></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>