| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.util.logging (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.util, package: org.apache.sis.util.logging"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.logging package"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../module-summary.html">Module</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>Class</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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.util</a></div> |
| <h1 title="Package org.apache.sis.util.logging" class="title">Package org.apache.sis.util.logging</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.util.logging</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Extensions to the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/package-summary.html" class="external-link">JDK logging</a> framework. |
| This package provides: |
| |
| <ul> |
| <li>A <a href="Logging.html" title="class in org.apache.sis.util.logging"><code>Logging</code></a> utility class with static utility methods.</li> |
| <li>A <a href="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="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> |
| |
| <h2 id="choosing-a-logging-framework-heading">Choosing a logging framework</h2> |
| The SIS project uses the standard <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html" title="class or interface in java.util.logging" class="external-link"><code>Logger</code></a> API for its logging. |
| It does not mean that users of the SIS library are forced to use that logging framework. |
| Java logging can be used as an API more powerful than <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.Logger.html" title="class or interface in java.lang" class="external-link"><code>System.Logger</code></a> |
| and other frameworks can redirect Java logging to themselves. For example, adding the |
| <code>jul-to-slf4j.jar</code> dependency to a project is sufficient for redirecting Java logging to SLF4J.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/18/core/java-logging-overview.html">Java Logging Overview</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Module</div> |
| <div class="table-header col-second">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-plain even-row-color"><a href="../../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.util</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Simple data objects and miscellaneous utilities.</div> |
| </div> |
| <div class="col-plain odd-row-color"><a href="../../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="col-first odd-row-color"><a href="../collection/package-summary.html">org.apache.sis.util.collection</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Addition to the collection framework.</div> |
| </div> |
| <div class="col-plain even-row-color"><a href="../../../../../../org.apache.sis.metadata/module-summary.html">org.apache.sis.metadata</a></div> |
| <div class="col-first even-row-color"><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/package-summary.html">org.apache.sis.util.iso</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implementations of GeoAPI types from the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/package-summary.html" class="external-link"><code>org.opengis.util</code></a> package.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="caption"><span>Classes</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Initializer.html" title="class in org.apache.sis.util.logging">Initializer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Loads a logging configuration file using Java logging syntax augmented with Apache SIS extensions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Logging.html" title="class in org.apache.sis.util.logging">Logging</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A set of utilities method for configuring loggings in SIS.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MonolineFormatter.html" title="class in org.apache.sis.util.logging">MonolineFormatter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A formatter writing log messages on a single line.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PerformanceLevel.html" title="class in org.apache.sis.util.logging">PerformanceLevel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Logging levels for data processing with execution time measurements.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
