| <!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 --> |
| <title>org.apache.daffodil.japi.logger (Apache Daffodil 3.1.0 Java API)</title> |
| <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.daffodil.japi.logger (Apache Daffodil 3.1.0 Java 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-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/daffodil/japi/io/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/daffodil/udf/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/daffodil/japi/logger/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.daffodil.japi.logger</h1> |
| <div class="docSummary"> |
| <div class="block">Provides the classes necessary to receive logging messages from Daffodil.</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="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/daffodil/japi/logger/ConsoleLogWriter.html" title="class in org.apache.daffodil.japi.logger">ConsoleLogWriter</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/daffodil/japi/logger/LogWriter.html" title="class in org.apache.daffodil.japi.logger"><code>LogWriter</code></a> that writes log messages to stdout</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/logger/FileLogWriter.html" title="class in org.apache.daffodil.japi.logger">FileLogWriter</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/daffodil/japi/logger/LogWriter.html" title="class in org.apache.daffodil.japi.logger"><code>LogWriter</code></a> that writes all log messages to a file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/logger/LogWriter.html" title="class in org.apache.daffodil.japi.logger">LogWriter</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract log writer, which can be overridden to create a custom log writer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/logger/NullLogWriter.html" title="class in org.apache.daffodil.japi.logger">NullLogWriter</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/daffodil/japi/logger/LogWriter.html" title="class in org.apache.daffodil.japi.logger"><code>LogWriter</code></a> that drops all log messages</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/logger/LogLevel.html" title="enum in org.apache.daffodil.japi.logger">LogLevel</a></td> |
| <td class="colLast"> |
| <div class="block">Logging levels.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.daffodil.japi.logger Description">Package org.apache.daffodil.japi.logger Description</h2> |
| <div class="block">Provides the classes necessary to receive logging messages from Daffodil. |
| |
| <h2>Overview</h2> |
| |
| Daffodil comes with three prebuilt log writers: |
| <ul> |
| <li><a href="../../../../../org/apache/daffodil/japi/logger/ConsoleLogWriter.html" title="class in org.apache.daffodil.japi.logger"><code>ConsoleLogWriter</code></a> - writes all log messages to stdout</li> |
| <li><a href="../../../../../org/apache/daffodil/japi/logger/FileLogWriter.html" title="class in org.apache.daffodil.japi.logger"><code>FileLogWriter</code></a> - writes all log messages to file</li> |
| <li><a href="../../../../../org/apache/daffodil/japi/logger/NullLogWriter.html" title="class in org.apache.daffodil.japi.logger"><code>NullLogWriter</code></a> - drop all log messages</li> |
| </ul> |
| |
| To use one of these log writers, create and instance of it and pass it to |
| <a href="../../../../../org/apache/daffodil/japi/Daffodil.html#setLogWriter-org.apache.daffodil.japi.logger.LogWriter-"><code>Daffodil.setLogWriter(org.apache.daffodil.japi.logger.LogWriter)</code></a>. For example, to write all logs to <code>/var/log/daffodil.log</code>: |
| |
| <pre> |
| <code> |
| FileLogWriter lw = new FileLogWriter(new File("/var/log/daffodil.log")); |
| Daffodil.setLogWriter(lw); |
| </code></pre> |
| |
| One may also change the log level using <a href="../../../../../org/apache/daffodil/japi/Daffodil.html#setLoggingLevel-org.apache.daffodil.japi.logger.LogLevel-"><code>Daffodil.setLoggingLevel(org.apache.daffodil.japi.logger.LogLevel)</code></a>, which defaults to <a href="../../../../../org/apache/daffodil/japi/logger/LogLevel.html#Info"><code>LogLevel.Info</code></a> if not set. For example, to change the log level to <a href="../../../../../org/apache/daffodil/japi/logger/LogLevel.html#Warning"><code>LogLevel.Warning</code></a>: |
| <pre> |
| <code> |
| Daffodil.setLoggingLevel(LogLevel.Warning); |
| </code></pre></div> |
| </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-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/daffodil/japi/io/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/daffodil/udf/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/daffodil/japi/logger/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 ======= --> |
| </body> |
| </html> |
