| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>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, class: Logging"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.logging.Logging class"> |
| <meta name="keywords" content="getLogger()"> |
| <meta name="keywords" content="log()"> |
| <meta name="keywords" content="completeAndLog()"> |
| <meta name="keywords" content="unexpectedException()"> |
| <meta name="keywords" content="recoverableException()"> |
| <meta name="keywords" content="ignorableException()"> |
| <meta name="keywords" content="severeException()"> |
| <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="class-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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.util.logging</a></div> |
| <h1 title="Class Logging" class="title">Class Logging</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../Static.html" title="class in org.apache.sis.util">Static</a> |
| <div class="inheritance">Logging</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Logging</span> |
| <span class="extends-implements">extends <a href="../Static.html" title="class in org.apache.sis.util">Static</a></span></div> |
| <div class="block">A set of utilities method for configuring loggings in SIS. |
| This class provides also some convenience static methods, including: |
| <ul> |
| <li><a href="#log(java.lang.Class,java.lang.String,java.util.logging.LogRecord)"><code>log(Class, String, LogRecord)</code></a> for <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#setLoggerName(java.lang.String)" title="class or interface in java.util.logging" class="external-link">setting |
| the logger name</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#setSourceClassName(java.lang.String)" title="class or interface in java.util.logging" class="external-link">source class name</a> and |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#setSourceMethodName(java.lang.String)" title="class or interface in java.util.logging" class="external-link">source method name</a> of the given record |
| before to log it.</li> |
| <li><a href="#unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>unexpectedException(Logger, Class, String, Throwable)</code></a> for reporting an anomalous but |
| nevertheless non-fatal exception.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#completeAndLog(java.util.logging.Logger,java.lang.Class,java.lang.String,java.util.logging.LogRecord)" class="member-name-link">completeAndLog</a><wbr>(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html" title="class or interface in java.util.logging" class="external-link">LogRecord</a> record)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Completes the properties of the given record, then logs to the specified or inferred logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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">Logger</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLogger(java.lang.Class)" class="member-name-link">getLogger</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a logger for the package of the specified class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ignorableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)" class="member-name-link">ignorableException</a><wbr>(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Invoked when an ignorable error occurred.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#log(java.lang.Class,java.lang.String,java.util.logging.LogRecord)" class="member-name-link">log</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html" title="class or interface in java.util.logging" class="external-link">LogRecord</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Replaced by <code>completeAndLog(null, record, classe, method)</code> for encouraging |
| the use of static <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> constants.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#recoverableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)" class="member-name-link">recoverableException</a><wbr>(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Invoked when a recoverable error occurred.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#severeException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)" class="member-name-link">severeException</a><wbr>(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Invoked when a severe error occurred.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)" class="member-name-link">unexpectedException</a><wbr>(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Invoked when an unexpected error occurred.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getLogger(java.lang.Class)"> |
| <h3>getLogger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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">Logger</a></span> <span class="element-name">getLogger</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> source)</span></div> |
| <div class="block">Returns a logger for the package of the specified class. This convenience method invokes |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html#getLogger(java.lang.String)" title="class or interface in java.util.logging" class="external-link"><code>Logger.getLogger(String)</code></a> with the package name of the given class taken as the logger name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the class which will emit a logging message.</dd> |
| <dt>Returns:</dt> |
| <dd>a logger for the specified class.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="log(java.lang.Class,java.lang.String,java.util.logging.LogRecord)"> |
| <h3>log</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.4", |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#forRemoval()" title="class or interface in java.lang" class="external-link">forRemoval</a>=true) |
| </span><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">log</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html" title="class or interface in java.util.logging" class="external-link">LogRecord</a> record)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span> |
| <div class="deprecation-comment">Replaced by <code>completeAndLog(null, record, classe, method)</code> for encouraging |
| the use of static <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> constants. Also the new name makes clear that the record is |
| modified.</div> |
| </div> |
| <div class="block">Logs the given record to the logger associated to the given class.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>classe</code> - the class to report as the source of the logging message.</dd> |
| <dd><code>method</code> - the method to report as the source of the logging message.</dd> |
| <dd><code>record</code> - the record to log.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="completeAndLog(java.util.logging.Logger,java.lang.Class,java.lang.String,java.util.logging.LogRecord)"> |
| <h3>completeAndLog</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">completeAndLog</span><wbr><span class="parameters">(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html" title="class or interface in java.util.logging" class="external-link">LogRecord</a> record)</span></div> |
| <div class="block">Completes the properties of the given record, then logs to the specified or inferred logger. |
| If the <code>logger</code> argument is <code>null</code>, the logger is inferred from the other arguments. |
| This convenience method performs the following steps: |
| |
| <ul> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#setSourceClassName(java.lang.String)" title="class or interface in java.util.logging" class="external-link">Set the source class name</a> |
| to the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html#getCanonicalName()" title="class or interface in java.lang" class="external-link">canonical name</a> of the given class.</li> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#setSourceMethodName(java.lang.String)" title="class or interface in java.util.logging" class="external-link">Set the source method name</a> |
| to the given value.</li> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#setLoggerName(java.lang.String)" title="class or interface in java.util.logging" class="external-link">Set the logger name</a> |
| to the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html#getName()" title="class or interface in java.util.logging" class="external-link">name</a> of the given logger if non null. |
| Otherwise use the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html#getPackageName()" title="class or interface in java.lang" class="external-link">package name of the class</a>.</li> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html#log(java.util.logging.LogRecord)" title="class or interface in java.util.logging" class="external-link">Log</a> the modified record to the specified <code>logger</code> if non null, |
| or to the logger specified by the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/LogRecord.html#getLoggerName()" title="class or interface in java.util.logging" class="external-link">logger name</a> otherwise.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - the logger where to log, or <code>null</code> for inferring from the logger or package name.</dd> |
| <dd><code>classe</code> - the class to report as the source of the logging message.</dd> |
| <dd><code>method</code> - the method to report as the source of the logging message.</dd> |
| <dd><code>record</code> - the record to complete and log.</dd> |
| <dt>Since:</dt> |
| <dd>1.4</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"> |
| <h3>unexpectedException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">unexpectedException</span><wbr><span class="parameters">(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</span></div> |
| <div class="block">Invoked when an unexpected error occurred. This method logs a message at <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#WARNING" title="class or interface in java.util.logging" class="external-link"><code>Level.WARNING</code></a> |
| to the specified logger. The originating class name and method name can optionally be specified. |
| If any of them is <code>null</code>, then it will be inferred from the error stack trace as described below. |
| If the <code>classe</code> or <code>method</code> arguments are null, then the originating class name and method name |
| are inferred from the given <code>error</code> using the first <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">stack trace element</a> |
| for which the class name is inside a package or sub-package of the same name than the logger name. |
| |
| <h4 id="recommended-usage-heading">Recommended usage</h4> |
| Explicit value for class and method names are preferred to automatic inference for the following reasons: |
| <ul> |
| <li>Automatic inference is not 100% reliable, since the Java Virtual Machine |
| is free to omit stack frame in optimized code.</li> |
| <li>When an exception occurred in a private method used internally by a public |
| method, we sometimes want to log the warning for the public method instead, |
| since the user is not expected to know anything about the existence of the |
| private method. If a developer really want to know about the private method, |
| the stack trace is still available anyway.</li> |
| </ul> |
| |
| <h4 id="example-heading">Example</h4> |
| If the logger name is <code>"org.apache.sis.image"</code>, then this method will uses the first stack |
| trace element where the fully qualified class name starts with <code>"org.apache.sis.image"</code> or |
| <code>"org.apache.sis.image.io"</code>, but not <code>"org.apache.sis.imageio"</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - where to log the error, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>classe</code> - the class where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>method</code> - the method where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>error</code> - the error, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the error has been logged, or <code>false</code> if the given <code>error</code> |
| was null or if the logger does not log anything at <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#WARNING" title="class or interface in java.util.logging" class="external-link"><code>Level.WARNING</code></a>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#recoverableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>recoverableException(Logger, Class, String, Throwable)</code></a></li> |
| <li><a href="#severeException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>severeException(Logger, Class, String, Throwable)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="recoverableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"> |
| <h3>recoverableException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">recoverableException</span><wbr><span class="parameters">(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</span></div> |
| <div class="block">Invoked when a recoverable error occurred. This method is similar to |
| <a href="#unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>unexpectedException(…)</code></a> |
| except that it does not log the stack trace and uses a lower logging level.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - where to log the error, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>classe</code> - the class where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>method</code> - the method name where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>error</code> - the error, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the error has been logged, or <code>false</code> if the given <code>error</code> |
| was null or if the logger does not log anything at <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#FINE" title="class or interface in java.util.logging" class="external-link"><code>Level.FINE</code></a>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>unexpectedException(Logger, Class, String, Throwable)</code></a></li> |
| <li><a href="#severeException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>severeException(Logger, Class, String, Throwable)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ignorableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"> |
| <h3>ignorableException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">ignorableException</span><wbr><span class="parameters">(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</span></div> |
| <div class="block">Invoked when an ignorable error occurred. This method is similar to |
| <a href="#recoverableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>unexpectedException(…)</code></a> |
| except that it uses a lower logging level.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - where to log the error, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>classe</code> - the class where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>method</code> - the method name where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>error</code> - the error, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the error has been logged, or <code>false</code> if the given <code>error</code> |
| was null or if the logger does not log anything at <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#FINER" title="class or interface in java.util.logging" class="external-link"><code>Level.FINER</code></a>.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="severeException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"> |
| <h3>severeException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">severeException</span><wbr><span class="parameters">(<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">Logger</a> logger, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> classe, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> method, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> error)</span></div> |
| <div class="block">Invoked when a severe error occurred. This method is similar to |
| <a href="#unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>unexpectedException</code></a> |
| except that it logs the message at the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#SEVERE" title="class or interface in java.util.logging" class="external-link"><code>SEVERE</code></a> level.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - where to log the error, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>classe</code> - the class where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>method</code> - the method name where the error occurred, or <code>null</code> for inferring a default value from other arguments.</dd> |
| <dd><code>error</code> - the error, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the error has been logged, or <code>false</code> if the given <code>error</code> |
| was null or if the logger does not log anything at <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#SEVERE" title="class or interface in java.util.logging" class="external-link"><code>Level.SEVERE</code></a>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#unexpectedException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>unexpectedException(Logger, Class, String, Throwable)</code></a></li> |
| <li><a href="#recoverableException(java.util.logging.Logger,java.lang.Class,java.lang.String,java.lang.Throwable)"><code>recoverableException(Logger, Class, String, Throwable)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |