| <!DOCTYPE html > |
| <html> |
| <head> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" /> |
| <title>Scala 2.12 wrapper for Log4j API 11.0 API - org.apache.logging.log4j.scala</title> |
| <meta name="description" content="Scala 2.12 wrapper for Log4j API 11.0 API - org.apache.logging.log4j.scala" /> |
| <meta name="keywords" content="Scala 2.12 wrapper for Log4j API 11.0 API org.apache.logging.log4j.scala" /> |
| <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/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" /> |
| <script type="text/javascript" src="../../../../../lib/jquery.js"></script> |
| <script type="text/javascript" src="../../../../../lib/jquery.panzoom.min.js"></script> |
| <script type="text/javascript" src="../../../../../lib/jquery.mousewheel.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" src="../../../../../lib/tools.tooltip.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">Scala 2.12 wrapper for Log4j API 11.0 API<span id="doc-version"></span></span> |
| <span class="close-results"><span class="left"><</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 name="_root_.root" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="_root_"></a><a id="root:_root_"></a> |
| <span class="permalink"> |
| <a href="index.html#_root_" 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 title="" href="../../../../../index.html"> |
| <span class="name">root</span> |
| </a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../../../index.html" class="extype" name="_root_">root</a></dd></dl></div> |
| </li><li name="_root_.org" visbl="pub" class="indented1 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="org"></a><a id="org:org"></a> |
| <span class="permalink"> |
| <a href="index.html#org" 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 title="" href="../../../../index.html"> |
| <span class="name">org</span> |
| </a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../../../index.html" class="extype" name="_root_">root</a></dd></dl></div> |
| </li><li name="org.apache" visbl="pub" class="indented2 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="apache"></a><a id="apache:apache"></a> |
| <span class="permalink"> |
| <a href="../org/index.html#apache" 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 title="" href="../../../index.html"> |
| <span class="name">apache</span> |
| </a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../../index.html" class="extype" name="org">org</a></dd></dl></div> |
| </li><li name="org.apache.logging" visbl="pub" class="indented3 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="logging"></a><a id="logging:logging"></a> |
| <span class="permalink"> |
| <a href="../../org/apache/index.html#logging" 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 title="" href="../../index.html"> |
| <span class="name">logging</span> |
| </a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../index.html" class="extype" name="org.apache">apache</a></dd></dl></div> |
| </li><li name="org.apache.logging.log4j" visbl="pub" class="indented4 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="log4j"></a><a id="log4j:log4j"></a> |
| <span class="permalink"> |
| <a href="../../../org/apache/logging/index.html#log4j" 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 title="" href="../index.html"> |
| <span class="name">log4j</span> |
| </a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../index.html" class="extype" name="org.apache.logging">logging</a></dd></dl></div> |
| </li><li name="org.apache.logging.log4j.scala" visbl="pub" class="indented5 current" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="scala"></a><a id="scala:scala"></a> |
| <span class="permalink"> |
| <a href="../../../../org/apache/logging/log4j/index.html#scala" 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" class="extype" name="org.apache.logging.log4j">log4j</a></dd></dl></div> |
| </li><li class="current-entities indented5"> |
| <a class="object" href="Logger$.html" title="Factory for Loggers."></a> |
| <a class="class" href="Logger.html" title="Scala wrapper for the Log4j Logger interface."></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 class="trait" 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."></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 class="object" href="LoggingContext$.html" title="Manages the context data (context map, MDC) that is added to log events."></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" class="extype" name="org">org</a>.<a href="../../../index.html" class="extype" name="org.apache">apache</a>.<a href="../../index.html" class="extype" name="org.apache.logging">logging</a>.<a href="../index.html" class="extype" name="org.apache.logging.log4j">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 id="mbrsel-input" placeholder="Filter all members" 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="all out"><span>All</span></li></ol> |
| </div> |
| </div> |
| </div> |
| |
| <div id="template"> |
| <div id="allMembers"> |
| |
| |
| <div id="types" class="types members"> |
| <h3>Type Members</h3> |
| <ol><li name="org.apache.logging.log4j.scala.Logger" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="LoggerextendsAnyVal"></a><a id="Logger:Logger"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/logging/log4j/scala/index.html#LoggerextendsAnyVal" 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 title="Scala wrapper for the Log4j Logger interface." href="Logger.html"> |
| <span class="name">Logger</span> |
| </a><span class="result"> extends <span class="extype" name="scala.AnyVal">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 name="org.apache.logging.log4j.scala.Logging" visbl="pub" class="indented0 " data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="LoggingextendsAnyRef"></a><a id="Logging:Logging"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/logging/log4j/scala/index.html#LoggingextendsAnyRef" 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 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." href="Logging.html"> |
| <span class="name">Logging</span> |
| </a><span class="result"> extends <span class="extype" name="scala.AnyRef">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" class="extype" name="org.apache.logging.log4j.scala.Logger">Logger</a> named according to the class.</p> |
| </li></ol> |
| </div> |
| |
| |
| |
| <div class="values members"> |
| <h3>Value Members</h3> |
| <ol> |
| <li name="org.apache.logging.log4j.scala.Logger" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="Logger"></a><a id="Logger:Logger"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/logging/log4j/scala/index.html#Logger" 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 title="Factory for Loggers." href="Logger$.html"> |
| <span class="name">Logger</span> |
| </a> |
| </span> |
| |
| <p class="shortcomment cmt">Factory for <a href="Logger.html" class="extype" name="org.apache.logging.log4j.scala.Logger">Logger</a>s.</p><div class="fullcomment"><div class="comment cmt"><p>Factory for <a href="Logger.html" class="extype" name="org.apache.logging.log4j.scala.Logger">Logger</a>s.</p><p>The <a href="Logging.html" class="extype" name="org.apache.logging.log4j.scala.Logging">Logging</a> trait provides a simple way to get a properly named logger into a class. |
| </p></div></div> |
| </li><li name="org.apache.logging.log4j.scala.LoggingContext" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="LoggingContext"></a><a id="LoggingContext:LoggingContext"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/logging/log4j/scala/index.html#LoggingContext" 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 title="Manages the context data (context map, MDC) that is added to log events." href="LoggingContext$.html"> |
| <span class="name">LoggingContext</span> |
| </a><span class="result"> extends <span class="extype" name="scala.collection.mutable.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.String">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 class="group" name="Ungrouped"> |
| <h3>Ungrouped</h3> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="tooltip"></div> |
| |
| <div id="footer"> </div> |
| </body> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
