/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/util/Log.html

# · HTML · 597 lines · 517 code · 66 blank · 14 comment · 0 complexity · ff674ff0013f61937b2dec13e7ac63b3 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.5.0_14) on Tue Jul 22 07:14:16 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. Log (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.util.Log class">
    11. 

  11. 

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

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

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

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

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

  33.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Log.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

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

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

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

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

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../../org/gjt/sp/util/IOUtilities.html" title="class in org.gjt.sp.util"><B>PREV CLASS</B></A>&nbsp;
    51. 

  51. &nbsp;<A HREF="../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util"><B>NEXT CLASS</B></A></FONT></TD>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../../index.html?org/gjt/sp/util/Log.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="Log.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. <TR>
    64. 

  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    65. 

  65.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    66. 

  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    67. 

  67. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    68. 

  68. </TR>
    69. 

  69. </TABLE>
    70. 

  70. <A NAME="skip-navbar_top"></A>
    71. 

  71. <!-- ========= END OF TOP NAVBAR ========= -->
    72. 

  72. 

  73. <HR>
    74. 

  74. <!-- ======== START OF CLASS DATA ======== -->
    75. 

  75. <H2>
    76. 

  76. <FONT SIZE="-1">
    77. 

  77. org.gjt.sp.util</FONT>
    78. 

  78. <BR>
    79. 

  79. Class Log</H2>
    80. 

  80. <PRE>
    81. 

  81. java.lang.Object
    82. 

  82.   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.util.Log</B>
    83. 

  83. </PRE>
    84. 

  84. <HR>
    85. 

  85. <DL>
    86. 

  86. <DT><PRE>public class <B>Log</B><DT>extends java.lang.Object</DL>
    87. 

  87. </PRE>
    88. 

  88. 

  89. <P>
    90. 

  90. This class provides methods for logging events. In terms of functionality,
    91. 

  91.  it is somewhere in between <code>System.out.println()</code> and
    92. 

  92.  full-blown logging packages such as log4j.<p>
    93. 

  93. 

  94.  All events are logged to an in-memory buffer and optionally a stream,
    95. 

  95.  and those with a high urgency (warnings and errors) are also printed
    96. 

  96.  to standard output.<p>
    97. 

  97. 

  98.  Logging of exception tracebacks is supported.<p>
    99. 

  99. 

  100.  This class can also optionally redirect standard output and error to the log.
    101. 

  101. <P>
    102. 

  102. 

  103. <P>
    104. 

  104. <HR>
    105. 

  105. 

  106. <P>
    107. 

  107. <!-- =========== FIELD SUMMARY =========== -->
    108. 

  108. 

  109. <A NAME="field_summary"><!-- --></A>
    110. 

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

  111. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    112. 

  112. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    113. 

  113. <B>Field Summary</B></FONT></TH>
    114. 

  114. </TR>
    115. 

  115. <TR BGCOLOR="white" CLASS="TableRowColor">
    116. 

  116. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    117. 

  117. <CODE>static&nbsp;int</CODE></FONT></TD>
    118. 

  118. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#DEBUG">DEBUG</A></B></CODE>
    119. 

  119. 

  120. <BR>
    121. 

  121. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Debugging message urgency.</TD>
    122. 

  122. </TR>
    123. 

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

  124. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    125. 

  125. <CODE>static&nbsp;int</CODE></FONT></TD>
    126. 

  126. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#ERROR">ERROR</A></B></CODE>
    127. 

  127. 

  128. <BR>
    129. 

  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Error urgency.</TD>
    130. 

  130. </TR>
    131. 

  131. <TR BGCOLOR="white" CLASS="TableRowColor">
    132. 

  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    133. 

  133. <CODE>static&nbsp;int</CODE></FONT></TD>
    134. 

  134. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#MAXLINES">MAXLINES</A></B></CODE>
    135. 

  135. 

  136. <BR>
    137. 

  137. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The maximum number of log messages that will be kept in memory.</TD>
    138. 

  138. </TR>
    139. 

  139. <TR BGCOLOR="white" CLASS="TableRowColor">
    140. 

  140. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    141. 

  141. <CODE>static&nbsp;int</CODE></FONT></TD>
    142. 

  142. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#MESSAGE">MESSAGE</A></B></CODE>
    143. 

  143. 

  144. <BR>
    145. 

  145. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Message urgency.</TD>
    146. 

  146. </TR>
    147. 

  147. <TR BGCOLOR="white" CLASS="TableRowColor">
    148. 

  148. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    149. 

  149. <CODE>static&nbsp;int</CODE></FONT></TD>
    150. 

  150. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#NOTICE">NOTICE</A></B></CODE>
    151. 

  151. 

  152. <BR>
    153. 

  153. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notice urgency.</TD>
    154. 

  154. </TR>
    155. 

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

  156. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    157. 

  157. <CODE>static&nbsp;java.util.List&lt;java.lang.Throwable&gt;</CODE></FONT></TD>
    158. 

  158. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#throwables">throwables</A></B></CODE>
    159. 

  159. 

  160. <BR>
    161. 

  161. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    162. 

  162. </TR>
    163. 

  163. <TR BGCOLOR="white" CLASS="TableRowColor">
    164. 

  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    165. 

  165. <CODE>static&nbsp;int</CODE></FONT></TD>
    166. 

  166. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#WARNING">WARNING</A></B></CODE>
    167. 

  167. 

  168. <BR>
    169. 

  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Warning urgency.</TD>
    170. 

  170. </TR>
    171. 

  171. </TABLE>
    172. 

  172. &nbsp;
    173. 

  173. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    174. 

  174. 

  175. <A NAME="constructor_summary"><!-- --></A>
    176. 

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

  177. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    178. 

  178. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    179. 

  179. <B>Constructor Summary</B></FONT></TH>
    180. 

  180. </TR>
    181. 

  181. <TR BGCOLOR="white" CLASS="TableRowColor">
    182. 

  182. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#Log()">Log</A></B>()</CODE>
    183. 

  183. 

  184. <BR>
    185. 

  185. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    186. 

  186. </TR>
    187. 

  187. </TABLE>
    188. 

  188. &nbsp;
    189. 

  189. <!-- ========== METHOD SUMMARY =========== -->
    190. 

  190. 

  191. <A NAME="method_summary"><!-- --></A>
    192. 

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

  193. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    194. 

  194. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    195. 

  195. <B>Method Summary</B></FONT></TH>
    196. 

  196. </TR>
    197. 

  197. <TR BGCOLOR="white" CLASS="TableRowColor">
    198. 

  198. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    199. 

  199. <CODE>static&nbsp;void</CODE></FONT></TD>
    200. 

  200. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#closeStream()">closeStream</A></B>()</CODE>
    201. 

  201. 

  202. <BR>
    203. 

  203. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the log stream.</TD>
    204. 

  204. </TR>
    205. 

  205. <TR BGCOLOR="white" CLASS="TableRowColor">
    206. 

  206. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    207. 

  207. <CODE>static&nbsp;void</CODE></FONT></TD>
    208. 

  208. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#flushStream()">flushStream</A></B>()</CODE>
    209. 

  209. 

  210. <BR>
    211. 

  211. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flushes the log stream.</TD>
    212. 

  212. </TR>
    213. 

  213. <TR BGCOLOR="white" CLASS="TableRowColor">
    214. 

  214. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    215. 

  215. <CODE>static&nbsp;javax.swing.ListModel</CODE></FONT></TD>
    216. 

  216. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#getLogListModel()">getLogListModel</A></B>()</CODE>
    217. 

  217. 

  218. <BR>
    219. 

  219. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the list model for viewing the log contents.</TD>
    220. 

  220. </TR>
    221. 

  221. <TR BGCOLOR="white" CLASS="TableRowColor">
    222. 

  222. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    223. 

  223. <CODE>static&nbsp;void</CODE></FONT></TD>
    224. 

  224. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#init(boolean, int)">init</A></B>(boolean&nbsp;stdio,
    225. 

  225.      int&nbsp;level)</CODE>
    226. 

  226. 

  227. <BR>
    228. 

  228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the log.</TD>
    229. 

  229. </TR>
    230. 

  230. <TR BGCOLOR="white" CLASS="TableRowColor">
    231. 

  231. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    232. 

  232. <CODE>static&nbsp;void</CODE></FONT></TD>
    233. 

  233. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#log(int, java.lang.Object, java.lang.Object)">log</A></B>(int&nbsp;urgency,
    234. 

  234.     java.lang.Object&nbsp;source,
    235. 

  235.     java.lang.Object&nbsp;message)</CODE>
    236. 

  236. 

  237. <BR>
    238. 

  238. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs a message.</TD>
    239. 

  239. </TR>
    240. 

  240. <TR BGCOLOR="white" CLASS="TableRowColor">
    241. 

  241. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    242. 

  242. <CODE>static&nbsp;void</CODE></FONT></TD>
    243. 

  243. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#log(int, java.lang.Object, java.lang.Object, java.lang.Throwable)">log</A></B>(int&nbsp;urgency,
    244. 

  244.     java.lang.Object&nbsp;source,
    245. 

  245.     java.lang.Object&nbsp;message,
    246. 

  246.     java.lang.Throwable&nbsp;exception)</CODE>
    247. 

  247. 

  248. <BR>
    249. 

  249. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an exception with a message.</TD>
    250. 

  250. </TR>
    251. 

  251. <TR BGCOLOR="white" CLASS="TableRowColor">
    252. 

  252. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    253. 

  253. <CODE>static&nbsp;void</CODE></FONT></TD>
    254. 

  254. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/Log.html#setLogWriter(java.io.Writer)">setLogWriter</A></B>(java.io.Writer&nbsp;stream)</CODE>
    255. 

  255. 

  256. <BR>
    257. 

  257. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes all currently logged messages to this stream if there was no
    258. 

  258.  stream set previously, and sets the stream to write future log
    259. 

  259.  messages to.</TD>
    260. 

  260. </TR>
    261. 

  261. </TABLE>
    262. 

  262. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    263. 

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

  264. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    265. 

  265. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
    266. 

  266. </TR>
    267. 

  267. <TR BGCOLOR="white" CLASS="TableRowColor">
    268. 

  268. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
    269. 

  269. </TR>
    270. 

  270. </TABLE>
    271. 

  271. &nbsp;
    272. 

  272. <P>
    273. 

  273. 

  274. <!-- ============ FIELD DETAIL =========== -->
    275. 

  275. 

  276. <A NAME="field_detail"><!-- --></A>
    277. 

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

  278. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    279. 

  279. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    280. 

  280. <B>Field Detail</B></FONT></TH>
    281. 

  281. </TR>
    282. 

  282. </TABLE>
    283. 

  283. 

  284. <A NAME="MAXLINES"><!-- --></A><H3>
    285. 

  285. MAXLINES</H3>
    286. 

  286. <PRE>
    287. 

  287. public static final int <B>MAXLINES</B></PRE>
    288. 

  288. <DL>
    289. 

  289. <DD>The maximum number of log messages that will be kept in memory.
    290. 

  290. <P>
    291. 

  291. <DL>
    292. 

  292. <DT><B>Since:</B></DT>
    293. 

  293.   <DD>jEdit 2.6pre5</DD>
    294. 

  294. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.gjt.sp.util.Log.MAXLINES">Constant Field Values</A></DL>
    295. 

  295. </DL>
    296. 

  296. <HR>
    297. 

  297. 

  298. <A NAME="DEBUG"><!-- --></A><H3>
    299. 

  299. DEBUG</H3>
    300. 

  300. <PRE>
    301. 

  301. public static final int <B>DEBUG</B></PRE>
    302. 

  302. <DL>
    303. 

  303. <DD>Debugging message urgency. Should be used for messages only
    304. 

  304.  useful when debugging a problem.
    305. 

  305. <P>
    306. 

  306. <DL>
    307. 

  307. <DT><B>Since:</B></DT>
    308. 

  308.   <DD>jEdit 2.2pre2</DD>
    309. 

  309. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.gjt.sp.util.Log.DEBUG">Constant Field Values</A></DL>
    310. 

  310. </DL>
    311. 

  311. <HR>
    312. 

  312. 

  313. <A NAME="MESSAGE"><!-- --></A><H3>
    314. 

  314. MESSAGE</H3>
    315. 

  315. <PRE>
    316. 

  316. public static final int <B>MESSAGE</B></PRE>
    317. 

  317. <DL>
    318. 

  318. <DD>Message urgency. Should be used for messages which give more
    319. 

  319.  detail than notices.
    320. 

  320. <P>
    321. 

  321. <DL>
    322. 

  322. <DT><B>Since:</B></DT>
    323. 

  323.   <DD>jEdit 2.2pre2</DD>
    324. 

  324. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.gjt.sp.util.Log.MESSAGE">Constant Field Values</A></DL>
    325. 

  325. </DL>
    326. 

  326. <HR>
    327. 

  327. 

  328. <A NAME="NOTICE"><!-- --></A><H3>
    329. 

  329. NOTICE</H3>
    330. 

  330. <PRE>
    331. 

  331. public static final int <B>NOTICE</B></PRE>
    332. 

  332. <DL>
    333. 

  333. <DD>Notice urgency. Should be used for messages that directly
    334. 

  334.  affect the user.
    335. 

  335. <P>
    336. 

  336. <DL>
    337. 

  337. <DT><B>Since:</B></DT>
    338. 

  338.   <DD>jEdit 2.2pre2</DD>
    339. 

  339. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.gjt.sp.util.Log.NOTICE">Constant Field Values</A></DL>
    340. 

  340. </DL>
    341. 

  341. <HR>
    342. 

  342. 

  343. <A NAME="WARNING"><!-- --></A><H3>
    344. 

  344. WARNING</H3>
    345. 

  345. <PRE>
    346. 

  346. public static final int <B>WARNING</B></PRE>
    347. 

  347. <DL>
    348. 

  348. <DD>Warning urgency. Should be used for messages that warrant
    349. 

  349.  attention.
    350. 

  350. <P>
    351. 

  351. <DL>
    352. 

  352. <DT><B>Since:</B></DT>
    353. 

  353.   <DD>jEdit 2.2pre2</DD>
    354. 

  354. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.gjt.sp.util.Log.WARNING">Constant Field Values</A></DL>
    355. 

  355. </DL>
    356. 

  356. <HR>
    357. 

  357. 

  358. <A NAME="ERROR"><!-- --></A><H3>
    359. 

  359. ERROR</H3>
    360. 

  360. <PRE>
    361. 

  361. public static final int <B>ERROR</B></PRE>
    362. 

  362. <DL>
    363. 

  363. <DD>Error urgency. Should be used for messages that signal a
    364. 

  364.  failure.
    365. 

  365. <P>
    366. 

  366. <DL>
    367. 

  367. <DT><B>Since:</B></DT>
    368. 

  368.   <DD>jEdit 2.2pre2</DD>
    369. 

  369. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.gjt.sp.util.Log.ERROR">Constant Field Values</A></DL>
    370. 

  370. </DL>
    371. 

  371. <HR>
    372. 

  372. 

  373. <A NAME="throwables"><!-- --></A><H3>
    374. 

  374. throwables</H3>
    375. 

  375. <PRE>
    376. 

  376. public static final java.util.List&lt;java.lang.Throwable&gt; <B>throwables</B></PRE>
    377. 

  377. <DL>
    378. 

  378. <DL>
    379. 

  379. </DL>
    380. 

  380. </DL>
    381. 

  381. 

  382. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    383. 

  383. 

  384. <A NAME="constructor_detail"><!-- --></A>
    385. 

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

  386. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    387. 

  387. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    388. 

  388. <B>Constructor Detail</B></FONT></TH>
    389. 

  389. </TR>
    390. 

  390. </TABLE>
    391. 

  391. 

  392. <A NAME="Log()"><!-- --></A><H3>
    393. 

  393. Log</H3>
    394. 

  394. <PRE>
    395. 

  395. public <B>Log</B>()</PRE>
    396. 

  396. <DL>
    397. 

  397. </DL>
    398. 

  398. 

  399. <!-- ============ METHOD DETAIL ========== -->
    400. 

  400. 

  401. <A NAME="method_detail"><!-- --></A>
    402. 

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

  403. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    404. 

  404. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    405. 

  405. <B>Method Detail</B></FONT></TH>
    406. 

  406. </TR>
    407. 

  407. </TABLE>
    408. 

  408. 

  409. <A NAME="init(boolean, int)"><!-- --></A><H3>
    410. 

  410. init</H3>
    411. 

  411. <PRE>
    412. 

  412. public static void <B>init</B>(boolean&nbsp;stdio,
    413. 

  413.                         int&nbsp;level)</PRE>
    414. 

  414. <DL>
    415. 

  415. <DD>Initializes the log.
    416. 

  416. <P>
    417. 

  417. <DD><DL>
    418. 

  418. <DT><B>Parameters:</B><DD><CODE>stdio</CODE> - If true, standard output and error will be
    419. 

  419.  sent to the log<DD><CODE>level</CODE> - Messages with this log level or higher will
    420. 

  420.  be printed to the system console<DT><B>Since:</B></DT>
    421. 

  421.   <DD>jEdit 3.2pre4</DD>
    422. 

  422. </DL>
    423. 

  423. </DD>
    424. 

  424. </DL>
    425. 

  425. <HR>
    426. 

  426. 

  427. <A NAME="setLogWriter(java.io.Writer)"><!-- --></A><H3>
    428. 

  428. setLogWriter</H3>
    429. 

  429. <PRE>
    430. 

  430. public static void <B>setLogWriter</B>(java.io.Writer&nbsp;stream)</PRE>
    431. 

  431. <DL>
    432. 

  432. <DD>Writes all currently logged messages to this stream if there was no
    433. 

  433.  stream set previously, and sets the stream to write future log
    434. 

  434.  messages to.
    435. 

  435. <P>
    436. 

  436. <DD><DL>
    437. 

  437. <DT><B>Parameters:</B><DD><CODE>stream</CODE> - The writer<DT><B>Since:</B></DT>
    438. 

  438.   <DD>jEdit 3.2pre4</DD>
    439. 

  439. </DL>
    440. 

  440. </DD>
    441. 

  441. </DL>
    442. 

  442. <HR>
    443. 

  443. 

  444. <A NAME="flushStream()"><!-- --></A><H3>
    445. 

  445. flushStream</H3>
    446. 

  446. <PRE>
    447. 

  447. public static void <B>flushStream</B>()</PRE>
    448. 

  448. <DL>
    449. 

  449. <DD>Flushes the log stream.
    450. 

  450. <P>
    451. 

  451. <DD><DL>
    452. 

  452. <DT><B>Since:</B></DT>
    453. 

  453.   <DD>jEdit 2.6pre5</DD>
    454. 

  454. </DL>
    455. 

  455. </DD>
    456. 

  456. </DL>
    457. 

  457. <HR>
    458. 

  458. 

  459. <A NAME="closeStream()"><!-- --></A><H3>
    460. 

  460. closeStream</H3>
    461. 

  461. <PRE>
    462. 

  462. public static void <B>closeStream</B>()</PRE>
    463. 

  463. <DL>
    464. 

  464. <DD>Closes the log stream. Should be done before your program exits.
    465. 

  465. <P>
    466. 

  466. <DD><DL>
    467. 

  467. <DT><B>Since:</B></DT>
    468. 

  468.   <DD>jEdit 2.6pre5</DD>
    469. 

  469. </DL>
    470. 

  470. </DD>
    471. 

  471. </DL>
    472. 

  472. <HR>
    473. 

  473. 

  474. <A NAME="getLogListModel()"><!-- --></A><H3>
    475. 

  475. getLogListModel</H3>
    476. 

  476. <PRE>
    477. 

  477. public static javax.swing.ListModel <B>getLogListModel</B>()</PRE>
    478. 

  478. <DL>
    479. 

  479. <DD>Returns the list model for viewing the log contents.
    480. 

  480. <P>
    481. 

  481. <DD><DL>
    482. 

  482. <DT><B>Since:</B></DT>
    483. 

  483.   <DD>jEdit 4.2pre1</DD>
    484. 

  484. </DL>
    485. 

  485. </DD>
    486. 

  486. </DL>
    487. 

  487. <HR>
    488. 

  488. 

  489. <A NAME="log(int, java.lang.Object, java.lang.Object, java.lang.Throwable)"><!-- --></A><H3>
    490. 

  490. log</H3>
    491. 

  491. <PRE>
    492. 

  492. public static void <B>log</B>(int&nbsp;urgency,
    493. 

  493.                        java.lang.Object&nbsp;source,
    494. 

  494.                        java.lang.Object&nbsp;message,
    495. 

  495.                        java.lang.Throwable&nbsp;exception)</PRE>
    496. 

  496. <DL>
    497. 

  497. <DD>Logs an exception with a message.
    498. 

  498. 

  499.  If an exception is the cause of a call to <A HREF="../../../../org/gjt/sp/util/Log.html#log"><CODE>log</CODE></A>, then
    500. 

  500.  the exception should be explicitly provided so that it can
    501. 

  501.  be presented to the (debugging) user in a useful manner
    502. 

  502.  (not just the exception message, but also the exception stack trace)
    503. 

  503. <P>
    504. 

  504. <DD><DL>
    505. 

  505. <DT><B>Since:</B></DT>
    506. 

  506.   <DD>jEdit 4.3pre5</DD>
    507. 

  507. </DL>
    508. 

  508. </DD>
    509. 

  509. </DL>
    510. 

  510. <HR>
    511. 

  511. 

  512. <A NAME="log(int, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
    513. 

  513. log</H3>
    514. 

  514. <PRE>
    515. 

  515. public static void <B>log</B>(int&nbsp;urgency,
    516. 

  516.                        java.lang.Object&nbsp;source,
    517. 

  517.                        java.lang.Object&nbsp;message)</PRE>
    518. 

  518. <DL>
    519. 

  519. <DD>Logs a message. This method is thread-safe.<p>
    520. 

  520. 

  521.  The following code sends a typical debugging message to the activity
    522. 

  522.  log:
    523. 

  523.  <pre>Log.log(Log.DEBUG,this,"counter = " + counter);</pre>
    524. 

  524.  The corresponding activity log entry might read as follows:
    525. 

  525.  <pre>[debug] JavaParser: counter = 15</pre>
    526. 

  526. <P>
    527. 

  527. <DD><DL>
    528. 

  528. <DT><B>Parameters:</B><DD><CODE>urgency</CODE> - The urgency; can be one of
    529. 

  529.  <code>Log.DEBUG</code>, <code>Log.MESSAGE</code>,
    530. 

  530.  <code>Log.NOTICE</code>, <code>Log.WARNING</code>, or
    531. 

  531.  <code>Log.ERROR</code>.<DD><CODE>source</CODE> - The source of the message, either an object or a
    532. 

  532.  class instance. When writing log messages from macros, set
    533. 

  533.  this parameter to <code>BeanShell.class</code> to make macro
    534. 

  534.  errors easier to spot in the activity log.<DD><CODE>message</CODE> - The message. This can either be a string or
    535. 

  535.  an exception<DT><B>Since:</B></DT>
    536. 

  536.   <DD>jEdit 2.2pre2</DD>
    537. 

  537. </DL>
    538. 

  538. </DD>
    539. 

  539. </DL>
    540. 

  540. <!-- ========= END OF CLASS DATA ========= -->
    541. 

  541. <HR>
    542. 

  542. 

  543. 

  544. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    545. 

  545. <A NAME="navbar_bottom"><!-- --></A>
    546. 

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

  547. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    548. 

  548. <TR>
    549. 

  549. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    550. 

  550. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    551. 

  551. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    552. 

  552.   <TR ALIGN="center" VALIGN="top">
    553. 

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

  554.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    555. 

  555.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    556. 

  556.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Log.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    557. 

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

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

  559.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    560. 

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

  561.   </TR>
    562. 

  562. </TABLE>
    563. 

  563. </TD>
    564. 

  564. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    565. 

  565. </EM>
    566. 

  566. </TD>
    567. 

  567. </TR>
    568. 

  568. 

  569. <TR>
    570. 

  570. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    571. 

  571. &nbsp;<A HREF="../../../../org/gjt/sp/util/IOUtilities.html" title="class in org.gjt.sp.util"><B>PREV CLASS</B></A>&nbsp;
    572. 

  572. &nbsp;<A HREF="../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util"><B>NEXT CLASS</B></A></FONT></TD>
    573. 

  573. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    574. 

  574.   <A HREF="../../../../index.html?org/gjt/sp/util/Log.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    575. 

  575. &nbsp;<A HREF="Log.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    576. 

  576. &nbsp;
    577. 

  577. <NOSCRIPT>
    578. 

  578.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    579. 

  579. </NOSCRIPT>
    580. 

  580. 

  581. 

  582. </FONT></TD>
    583. 

  583. </TR>
    584. 

  584. <TR>
    585. 

  585. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    586. 

  586.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    587. 

  587. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    588. 

  588. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    589. 

  589. </TR>
    590. 

  590. </TABLE>
    591. 

  591. <A NAME="skip-navbar_bottom"></A>
    592. 

  592. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    593. 

  593. 

  594. <HR>
    595. 

  595. 

  596. </BODY>
    597. 

  597. </HTML>
    598.