/apache-log4j-1.2.17/site/apidocs/org/apache/log4j/lf5/package-summary.html

# · HTML · 223 lines · 184 code · 23 blank · 16 comment · 0 complexity · 502485a72d5c92e2637140ad617f3f7d MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_23) -->
    6. 

  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <TITLE>
    8. 

  8. org.apache.log4j.lf5 (Apache Log4j 1.2.17 API)
    9. 

  9. </TITLE>
    10. 

  10. 

  11. <META NAME="date" CONTENT="2012-05-06">
    12. 

  12. 

  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    14. 

  14. 

  15. <SCRIPT type="text/javascript">
    16. 

  16. function windowTitle()
    17. 

  17. {
    18. 

  18.     if (location.href.indexOf('is-external=true') == -1) {
    19. 

  19.         parent.document.title="org.apache.log4j.lf5 (Apache Log4j 1.2.17 API)";
    20. 

  20.     }
    21. 

  21. }
    22. 

  22. </SCRIPT>
    23. 

  23. <NOSCRIPT>
    24. 

  24. </NOSCRIPT>
    25. 

  25. 

  26. </HEAD>
    27. 

  27. 

  28. <BODY BGCOLOR="white" onload="windowTitle();">
    29. 

  29. <HR>
    30. 

  30. 

  31. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <A NAME="navbar_top"><!-- --></A>
    34. 

  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    35. 

  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    36. 

  36. <TR>
    37. 

  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    38. 

  38. <A NAME="navbar_top_firstrow"><!-- --></A>
    39. 

  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    40. 

  40.   <TR ALIGN="center" VALIGN="top">
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    47. 

  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    48. 

  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    49. 

  49.   </TR>
    50. 

  50. </TABLE>
    51. 

  51. </TD>
    52. 

  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    53. 

  53. </EM>
    54. 

  54. </TD>
    55. 

  55. </TR>
    56. 

  56. 

  57. <TR>
    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    59. 

  59. &nbsp;<A HREF="../../../../org/apache/log4j/jmx/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    60. 

  60. &nbsp;<A HREF="../../../../org/apache/log4j/lf5/util/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    61. 

  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    62. 

  62.   <A HREF="../../../../index.html?org/apache/log4j/lf5/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    63. 

  63. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    64. 

  64. &nbsp;<SCRIPT type="text/javascript">
    65. 

  65.   <!--
    66. 

  66.   if(window==top) {
    67. 

  67.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    68. 

  68.   }
    69. 

  69.   //-->
    70. 

  70. </SCRIPT>
    71. 

  71. <NOSCRIPT>
    72. 

  72.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    73. 

  73. </NOSCRIPT>
    74. 

  74. 

  75. 

  76. </FONT></TD>
    77. 

  77. </TR>
    78. 

  78. </TABLE>
    79. 

  79. <A NAME="skip-navbar_top"></A>
    80. 

  80. <!-- ========= END OF TOP NAVBAR ========= -->
    81. 

  81. 

  82. <HR>
    83. 

  83. <H2>
    84. 

  84. Package org.apache.log4j.lf5
    85. 

  85. </H2>
    86. 

  86. 

  87. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    88. 

  88. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    89. 

  89. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    90. 

  90. <B>Interface Summary</B></FONT></TH>
    91. 

  91. </TR>
    92. 

  92. <TR BGCOLOR="white" CLASS="TableRowColor">
    93. 

  93. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/LogRecordFilter.html" title="interface in org.apache.log4j.lf5">LogRecordFilter</A></B></TD>
    94. 

  94. <TD>An interface for classes which filters LogRecords.</TD>
    95. 

  95. </TR>
    96. 

  96. </TABLE>
    97. 

  97. &nbsp;
    98. 

  98. 

  99. <P>
    100. 

  100. 

  101. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    102. 

  102. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    103. 

  103. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    104. 

  104. <B>Class Summary</B></FONT></TH>
    105. 

  105. </TR>
    106. 

  106. <TR BGCOLOR="white" CLASS="TableRowColor">
    107. 

  107. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/AppenderFinalizer.html" title="class in org.apache.log4j.lf5">AppenderFinalizer</A></B></TD>
    108. 

  108. <TD><code>AppenderFinalizer</code> has a single method that will finalize
    109. 

  109.  resources associated with a <code>LogBrokerMonitor</code> in the event
    110. 

  110.  that the <code>LF5Appender</code> class is destroyed, and the class loader
    111. 

  111.  is garbage collected.</TD>
    112. 

  112. </TR>
    113. 

  113. <TR BGCOLOR="white" CLASS="TableRowColor">
    114. 

  114. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/DefaultLF5Configurator.html" title="class in org.apache.log4j.lf5">DefaultLF5Configurator</A></B></TD>
    115. 

  115. <TD>The <code>DefaultLF5Configurator</code> provides a default
    116. 

  116.  configuration for the <code>LF5Appender</code>.</TD>
    117. 

  117. </TR>
    118. 

  118. <TR BGCOLOR="white" CLASS="TableRowColor">
    119. 

  119. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/LF5Appender.html" title="class in org.apache.log4j.lf5">LF5Appender</A></B></TD>
    120. 

  120. <TD><code>LF5Appender</code> logs events to a swing based logging
    121. 

  121.  console.</TD>
    122. 

  122. </TR>
    123. 

  123. <TR BGCOLOR="white" CLASS="TableRowColor">
    124. 

  124. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/Log4JLogRecord.html" title="class in org.apache.log4j.lf5">Log4JLogRecord</A></B></TD>
    125. 

  125. <TD>A <code>Log4JLogRecord</code> encapsulates
    126. 

  126.  the details of your log4j <code>LoggingEvent</code> in a format usable
    127. 

  127.  by the <code>LogBrokerMonitor</code>.</TD>
    128. 

  128. </TR>
    129. 

  129. <TR BGCOLOR="white" CLASS="TableRowColor">
    130. 

  130. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</A></B></TD>
    131. 

  131. <TD>The LogLevel class defines a set of standard logging levels.</TD>
    132. 

  132. </TR>
    133. 

  133. <TR BGCOLOR="white" CLASS="TableRowColor">
    134. 

  134. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/LogRecord.html" title="class in org.apache.log4j.lf5">LogRecord</A></B></TD>
    135. 

  135. <TD>LogRecord.</TD>
    136. 

  136. </TR>
    137. 

  137. <TR BGCOLOR="white" CLASS="TableRowColor">
    138. 

  138. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/PassingLogRecordFilter.html" title="class in org.apache.log4j.lf5">PassingLogRecordFilter</A></B></TD>
    139. 

  139. <TD>An implementation of LogRecordFilter which always returns true.</TD>
    140. 

  140. </TR>
    141. 

  141. <TR BGCOLOR="white" CLASS="TableRowColor">
    142. 

  142. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/StartLogFactor5.html" title="class in org.apache.log4j.lf5">StartLogFactor5</A></B></TD>
    143. 

  143. <TD>Starts an instance of the LogFactor5 console for off-line viewing.</TD>
    144. 

  144. </TR>
    145. 

  145. </TABLE>
    146. 

  146. &nbsp;
    147. 

  147. 

  148. <P>
    149. 

  149. 

  150. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    151. 

  151. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    152. 

  152. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    153. 

  153. <B>Exception Summary</B></FONT></TH>
    154. 

  154. </TR>
    155. 

  155. <TR BGCOLOR="white" CLASS="TableRowColor">
    156. 

  156. <TD WIDTH="15%"><B><A HREF="../../../../org/apache/log4j/lf5/LogLevelFormatException.html" title="class in org.apache.log4j.lf5">LogLevelFormatException</A></B></TD>
    157. 

  157. <TD>Thrown to indicate that the client has attempted to convert a string
    158. 

  158.  to one the LogLevel types, but the string does not have the appropriate
    159. 

  159.  format.</TD>
    160. 

  160. </TR>
    161. 

  161. </TABLE>
    162. 

  162. &nbsp;
    163. 

  163. 

  164. <P>
    165. 

  165. <DL>
    166. 

  166. </DL>
    167. 

  167. <HR>
    168. 

  168. 

  169. 

  170. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    171. 

  171. <A NAME="navbar_bottom"><!-- --></A>
    172. 

  172. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    173. 

  173. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    174. 

  174. <TR>
    175. 

  175. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    176. 

  176. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    177. 

  177. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    178. 

  178.   <TR ALIGN="center" VALIGN="top">
    179. 

  179.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    180. 

  180.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    181. 

  181.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    182. 

  182.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    183. 

  183.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    184. 

  184.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    185. 

  185.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    186. 

  186.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    187. 

  187.   </TR>
    188. 

  188. </TABLE>
    189. 

  189. </TD>
    190. 

  190. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    191. 

  191. </EM>
    192. 

  192. </TD>
    193. 

  193. </TR>
    194. 

  194. 

  195. <TR>
    196. 

  196. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    197. 

  197. &nbsp;<A HREF="../../../../org/apache/log4j/jmx/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    198. 

  198. &nbsp;<A HREF="../../../../org/apache/log4j/lf5/util/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    199. 

  199. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    200. 

  200.   <A HREF="../../../../index.html?org/apache/log4j/lf5/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    201. 

  201. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    202. 

  202. &nbsp;<SCRIPT type="text/javascript">
    203. 

  203.   <!--
    204. 

  204.   if(window==top) {
    205. 

  205.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    206. 

  206.   }
    207. 

  207.   //-->
    208. 

  208. </SCRIPT>
    209. 

  209. <NOSCRIPT>
    210. 

  210.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    211. 

  211. </NOSCRIPT>
    212. 

  212. 

  213. 

  214. </FONT></TD>
    215. 

  215. </TR>
    216. 

  216. </TABLE>
    217. 

  217. <A NAME="skip-navbar_bottom"></A>
    218. 

  218. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    219. 

  219. 

  220. <HR>
    221. 

  221. Copyright &#169; 1999-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
    222. 

  222. </BODY>
    223. 

  223. </HTML>
    224.