<html> <head> <title>Interface XLogger</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XLogger-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">logging</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XLogger</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>implemented by a component which is able to log events. </dd> <dd><p>This interface is roughly designed after the <a href="http://java.sun.com/javase/6/docs/api/java/util/logging/package-summary.html">Java Logging API</a>. However, there are some differences, the major ones being: <ul><li>There's no support (yet) for filtering log events.</li> <li>There ain't no convenience menthods for logging.</li> <li>There's no localization support.</li> <li>Logger instances do not form a hierarchy.</li> </ul></p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.3</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#addLogHandler">addLogHandler</a></td> <td class="imsum_right">adds the given handler to the list of handlers. </td> </tr> <tr> <td class="imsum_left"><a href="#removeLogHandler">removeLogHandler</a></td> <td class="imsum_right">removes the given handler from the list of handlers. </td> </tr> <tr> <td class="imsum_left"><a href="#isLoggable">isLoggable</a></td> <td class="imsum_right">determines whether logger instance would produce any output for the given level. </td> </tr> <tr> <td class="imsum_left"><a href="#log">log</a></td> <td class="imsum_right">logs a given message </td> </tr> <tr> <td class="imsum_left"><a href="#logp">logp</a></td> <td class="imsum_right">logs a given message, detailing the source class and method at which the logged event occured. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Name">Name</a></td> <td class="imsum_right">denotes the name of the logger. </td> </tr> <tr> <td class="imsum_left"><a href="#Level">Level</a></td> <td class="imsum_right">specifies which log events are logged or ignored. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="addLogHandler" class="membertitle">addLogHandler</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addLogHandler</b>(</td> <td valign="top">[in] <a href="XLogHandler.html">XLogHandler</a></td> <td valign="bottom"> LogHandler );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds the given handler to the list of handlers. </dd> <dd><p>When an event is logged, the logger will create a <a href="LogRecord.html">LogRecord</a> for this event, and pass this record to all registered handlers. Single handlers might or might not log those records at their own discretion, and depending on additional restrictions such as filters specified at handler level.</p> <p>Note: The log level of the given handler (<a href="XLogHandler.html">XLogHandler</a>::<a href="XLogHandler.html#Level">Level</a>) will not be touched. In particular, it will not be set to the logger's log level. It's the responsibility of the component which knits a logger with one or more log handlers to ensure that all loggers have appropriate levels set.</p> </dd> <dt><b>Parameter LogHandler</b></dt> <dd>the handler to add to the list of handlers. The call is ignored if this parameter is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeLogHandler" class="membertitle">removeLogHandler</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeLogHandler</b>(</td> <td valign="top">[in] <a href="XLogHandler.html">XLogHandler</a></td> <td valign="bottom"> LogHandler );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes the given handler from the list of handlers. </dd> <dt><b>Parameter LogHandler</b></dt> <dd>the handler to remove from the list of handlers. The call is ignored if this parameter is <b>NULL</b>, or if the handler has not previously beed added. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isLoggable" class="membertitle">isLoggable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isLoggable</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Level );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether logger instance would produce any output for the given level. </dd> <dd><p>The method can be used to optimize performance as maybe complex parameter evaluation in the <code>log</code> calls can be omitted if <code>isLoggable</code> evaluates to false.</p> </dd> <dt><b>Parameter Level</b></dt> <dd>level to be checked against </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if there would be some output for this XLogger for the given level, <b>false</b> otherwise. Note that a return value of <b>false</b> could also indicate that the logger does not have any log handlers associated with it. </dd> <dt><b>See also</b></dt> <dd><a href="#addLogHandler">addLogHandler</a>, <a href="#removeLogHandler">removeLogHandler</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="log" class="membertitle">log</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>log</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Level,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Message );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>logs a given message </dd> <dt><b>Parameter Level</b></dt> <dd>the log level of this message. If this level is smaller than the logger's <a href="#Level">Level</a> attribute, then the call will be ignored. </dd> <dt><b>Parameter Message</b></dt> <dd>the message to log </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="logp" class="membertitle">logp</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>logp</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Level,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> SourceClassName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> SourceMethodName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Message );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>logs a given message, detailing the source class and method at which the logged event occured. </dd> <dt><b>Parameter Level</b></dt> <dd>the log level of this message. If this level is smaller than the logger's <a href="#Level">Level</a> attribute, then the call will be ignored. </dd> <dt><b>Parameter SourceClass</b></dt> <dd>the source class at which the logged event occured. </dd> <dt><b>Parameter SourceMethod</b></dt> <dd>the source class at which the logged event occured. </dd> <dt><b>Parameter Message</b></dt> <dd>the message to log </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Name" class="membertitle">Name</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>Name</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the name of the logger. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Level" class="membertitle">Level</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Level</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies which log events are logged or ignored. </dd> <dt><b>See also</b></dt> <dd><a href="LogLevel.html">LogLevel</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
4299
