| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Wed Jul 13 13:04:21 CEST 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.sis.util.logging (Apache SIS 0.7 API)</title> |
| <meta name="date" content="2016-07-13"> |
| <meta name="keywords" content="org.apache.sis.util.logging package"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.sis.util.logging (Apache SIS 0.7 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/sis/util/iso/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/sis/xml/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sis/util/logging/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sis.util.logging</h1> |
| <div class="docSummary"> |
| <div class="block">Extensions to the <a href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/package-summary.html?is-external=true">JDK logging</a> framework.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/WarningListener.html" title="interface in org.apache.sis.util.logging">WarningListener</a><S></td> |
| <td class="colLast"> |
| <div class="block">Intercepts non-fatal error messages logged by <a href="../../../../../org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage"><code>DataStore</code></a> or other SIS objects.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/LoggerAdapter.html" title="class in org.apache.sis.util.logging">LoggerAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">An adapter that redirect all JDK logging events to an other logging framework.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/LoggerFactory.html" title="class in org.apache.sis.util.logging">LoggerFactory</a><L></td> |
| <td class="colLast"> |
| <div class="block">A factory for Java <a href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging"><code>Logger</code></a> wrapping an other logging framework.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/Logging.html" title="class in org.apache.sis.util.logging">Logging</a></td> |
| <td class="colLast"> |
| <div class="block">A set of utilities method for configuring loggings in SIS.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/MonolineFormatter.html" title="class in org.apache.sis.util.logging">MonolineFormatter</a></td> |
| <td class="colLast"> |
| <div class="block">A formatter writing log messages on a single line.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/PerformanceLevel.html" title="class in org.apache.sis.util.logging">PerformanceLevel</a></td> |
| <td class="colLast"> |
| <div class="block">Logging levels for measurements of execution time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sis/util/logging/WarningListeners.html" title="class in org.apache.sis.util.logging">WarningListeners</a><S></td> |
| <td class="colLast"> |
| <div class="block">Holds a list of <a href="../../../../../org/apache/sis/util/logging/WarningListener.html" title="interface in org.apache.sis.util.logging"><code>WarningListener</code></a> instances and provides convenience methods for emitting warnings.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.sis.util.logging Description">Package org.apache.sis.util.logging Description</h2> |
| <div class="block">Extensions to the <a href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/package-summary.html?is-external=true">JDK logging</a> framework. |
| This package provides: |
| |
| <ul> |
| <li>A <a href="../../../../../org/apache/sis/util/logging/Logging.html" title="class in org.apache.sis.util.logging"><code>Logging</code></a> utility class with static methods for |
| fetching a logger (see <cite>Choosing a logging framework</cite> below) or logging an |
| exception.</li> |
| <li>A <a href="../../../../../org/apache/sis/util/logging/PerformanceLevel.html" title="class in org.apache.sis.util.logging"><code>PerformanceLevel</code></a> with configurable levels for |
| logging the duration of lengthly processes.</li> |
| <li>A <a href="../../../../../org/apache/sis/util/logging/MonolineFormatter.html" title="class in org.apache.sis.util.logging"><code>MonolineFormatter</code></a> for formatting the log |
| records on single line with colors, for easier reading on the console output.</li> |
| </ul> |
| |
| <div class="section">Choosing a logging framework</div> |
| The SIS project uses the standard <a href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging"><code>Logger</code></a> API for its logging, |
| but this package allows redirection of logging messages to some other frameworks like |
| <a href="http://logging.apache.org/log4j/">Log4J</a>. |
| We recommend to stick to standard JDK logging when possible. However if inter-operability |
| with an other logging framework is required, then the only action needed is to include |
| <strong>one</strong> of the following JAR on the classpath: |
| |
| <ul> |
| <li><code>sis-logging-commons.jar</code> for Apache logging</li> |
| <li><code>sis-logging-log4j.jar</code> for Log4J logging</li> |
| <li>Any other JAR registering a <a href="../../../../../org/apache/sis/util/logging/LoggerFactory.html" title="class in org.apache.sis.util.logging"><code>LoggerFactory</code></a> implementation.</li> |
| </ul> |
| |
| <div class="section">Note for SIS developers</div> |
| All SIS code should fetch their logger through a call to our custom |
| <a href="../../../../../org/apache/sis/util/logging/Logging.html#getLogger-java.lang.String-"><code>Logging.getLogger(String)</code></a> method instead than |
| the standard <a href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Logger.html?is-external=true#getLogger-java.lang.String-" title="class or interface in java.util.logging"><code>Logger.getLogger(String)</code></a> method. This is necessary in |
| order to give SIS a chance to redirect log events to an other logging framework.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://download.oracle.com/javase/6/docs/technotes/guides/logging/overview.html">Java Logging Overview</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p> |
| </dl> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/sis/util/iso/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/sis/xml/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sis/util/logging/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2010–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
