Helix SwarmHelix Swarm

EventLog.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • EventLog.html #6
  • View
  • Commits
  • Open Download .zip Download (25 KB) 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc on Mon Aug 05 13:17:01 EDT 2002 -->
  6. <TITLE>
  7. Perforce API: Class  EventLog
  8. </TITLE>
  9. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  10. </HEAD>
  11. <BODY BGCOLOR="white">
  12.  
  13. <!-- ========== START OF NAVBAR ========== -->
  14. <A NAME="navbar_top"><!-- --></A>
  15. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  16. <TR>
  17. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  18. <A NAME="navbar_top_firstrow"><!-- --></A>
  19. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  20.   <TR ALIGN="center" VALIGN="top">
  21.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  22.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  23.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EventLog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  24.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  25.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  26.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  27.   </TR>
  28. </TABLE>
  29. </TD>
  30. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  31. <a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM>
  32. </TD>
  33. </TR>
  34.  
  35. <TR>
  36. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  37. &nbsp;<A HREF="../../../com/perforce/api/Env.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/FileEntry.html"><B>NEXT CLASS</B></A></FONT></TD>
  39. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  40.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  41. &nbsp;<A HREF="EventLog.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  42. </TR>
  43. <TR>
  44. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  45.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  46. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  47. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  48. </TR>
  49. </TABLE>
  50. <!-- =========== END OF NAVBAR =========== -->
  51.  
  52. <HR>
  53. <!-- ======== START OF CLASS DATA ======== -->
  54. <H2>
  55. <FONT SIZE="-1">
  56. com.perforce.api</FONT>
  57. <BR>
  58. Class  EventLog</H2>
  59. <PRE>
  60. <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
  61.   |
  62.   +--<B>com.perforce.api.EventLog</B>
  63. </PRE>
  64. <HR>
  65. <DL>
  66. <DT>public class <B>EventLog</B><DT>extends <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></DL>
  67.  
  68. <P>
  69. This class controls an event log. A set number of log entries are kept in
  70.  memory, but all log entries are sent to a log file.
  71. <P>
  72. <DL>
  73. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #6 $</DD>
  74. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  75. </DL>
  76. <HR>
  77.  
  78. <P>
  79. <!-- ======== INNER CLASS SUMMARY ======== -->
  80.  
  81.  
  82. <!-- =========== FIELD SUMMARY =========== -->
  83.  
  84.  
  85. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  86.  
  87. <A NAME="constructor_summary"><!-- --></A>
  88. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  89. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  90. <TD COLSPAN=2><FONT SIZE="+2">
  91. <B>Constructor Summary</B></FONT></TD>
  92. </TR>
  93. <TR BGCOLOR="white" CLASS="TableRowColor">
  94. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#EventLog()">EventLog</A></B>()</CODE>
  95.  
  96. <BR>
  97. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default, no-argument constructor.</TD>
  98. </TR>
  99. <TR BGCOLOR="white" CLASS="TableRowColor">
  100. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#EventLog(java.lang.String)">EventLog</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;title)</CODE>
  101.  
  102. <BR>
  103. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that accepts the title for this.</TD>
  104. </TR>
  105. <TR BGCOLOR="white" CLASS="TableRowColor">
  106. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#EventLog(java.lang.String, java.lang.String)">EventLog</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;title,
  107.          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;filename)</CODE>
  108.  
  109. <BR>
  110. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that sets the log title and ouput filename.</TD>
  111. </TR>
  112. </TABLE>
  113. &nbsp;
  114. <!-- ========== METHOD SUMMARY =========== -->
  115.  
  116. <A NAME="method_summary"><!-- --></A>
  117. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  118. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  119. <TD COLSPAN=2><FONT SIZE="+2">
  120. <B>Method Summary</B></FONT></TD>
  121. </TR>
  122. <TR BGCOLOR="white" CLASS="TableRowColor">
  123. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  124. <CODE>static&nbsp;void</CODE></FONT></TD>
  125. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#commonLog(java.lang.String)">commonLog</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event)</CODE>
  126.  
  127. <BR>
  128. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an event to the common log.</TD>
  129. </TR>
  130. <TR BGCOLOR="white" CLASS="TableRowColor">
  131. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  132. <CODE>static&nbsp;void</CODE></FONT></TD>
  133. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#commonLog(java.lang.String, java.lang.String)">commonLog</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  134.           <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level)</CODE>
  135.  
  136. <BR>
  137. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an event to the common log.</TD>
  138. </TR>
  139. <TR BGCOLOR="white" CLASS="TableRowColor">
  140. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  141. <CODE>static&nbsp;void</CODE></FONT></TD>
  142. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#commonLog(java.lang.String, java.lang.String, boolean)">commonLog</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  143.           <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level,
  144.           boolean&nbsp;encode)</CODE>
  145.  
  146. <BR>
  147. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an event to the common log.</TD>
  148. </TR>
  149. <TR BGCOLOR="white" CLASS="TableRowColor">
  150. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  151. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  152. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#getFileName()">getFileName</A></B>()</CODE>
  153.  
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the output file name.</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#getLog()">getLog</A></B>()</CODE>
  161.  
  162. <BR>
  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an Enumeration that contains all the events in the log.</TD>
  164. </TR>
  165. <TR BGCOLOR="white" CLASS="TableRowColor">
  166. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  167. <CODE>&nbsp;int</CODE></FONT></TD>
  168. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#getSize()">getSize</A></B>()</CODE>
  169.  
  170. <BR>
  171. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the size of the event log memory.</TD>
  172. </TR>
  173. <TR BGCOLOR="white" CLASS="TableRowColor">
  174. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  175. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  176. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#getTitle()">getTitle</A></B>()</CODE>
  177.  
  178. <BR>
  179. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the title of the log.</TD>
  180. </TR>
  181. <TR BGCOLOR="white" CLASS="TableRowColor">
  182. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  183. <CODE>&nbsp;void</CODE></FONT></TD>
  184. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#log(java.lang.String)">log</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event)</CODE>
  185.  
  186. <BR>
  187. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an event to this log.</TD>
  188. </TR>
  189. <TR BGCOLOR="white" CLASS="TableRowColor">
  190. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  191. <CODE>&nbsp;void</CODE></FONT></TD>
  192. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#log(java.lang.String, java.lang.String)">log</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  193.     <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level)</CODE>
  194.  
  195. <BR>
  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an event to this log.</TD>
  197. </TR>
  198. <TR BGCOLOR="white" CLASS="TableRowColor">
  199. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  200. <CODE>&nbsp;void</CODE></FONT></TD>
  201. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#log(java.lang.String, java.lang.String, boolean)">log</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  202.     <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level,
  203.     boolean&nbsp;encode)</CODE>
  204.  
  205. <BR>
  206. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an event to this log.</TD>
  207. </TR>
  208. <TR BGCOLOR="white" CLASS="TableRowColor">
  209. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  210. <CODE>static&nbsp;void</CODE></FONT></TD>
  211. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#printLog(com.perforce.api.EventLog, java.io.PrintWriter, java.lang.String)">printLog</A></B>(<A HREF="../../../com/perforce/api/EventLog.html">EventLog</A>&nbsp;elog,
  212.          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/PrintWriter.html">PrintWriter</A>&nbsp;out,
  213.          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;format)</CODE>
  214.  
  215. <BR>
  216. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prints a log, using the specified format.</TD>
  217. </TR>
  218. <TR BGCOLOR="white" CLASS="TableRowColor">
  219. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  220. <CODE>static&nbsp;void</CODE></FONT></TD>
  221. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#printLog(java.io.PrintWriter, java.lang.String)">printLog</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/PrintWriter.html">PrintWriter</A>&nbsp;out,
  222.          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;format)</CODE>
  223.  
  224. <BR>
  225. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prints this log, using the specified format.</TD>
  226. </TR>
  227. <TR BGCOLOR="white" CLASS="TableRowColor">
  228. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  229. <CODE>&nbsp;void</CODE></FONT></TD>
  230. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#setSize(int)">setSize</A></B>(int&nbsp;size)</CODE>
  231.  
  232. <BR>
  233. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the size of the log.</TD>
  234. </TR>
  235. <TR BGCOLOR="white" CLASS="TableRowColor">
  236. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  237. <CODE>&nbsp;void</CODE></FONT></TD>
  238. <TD><CODE><B><A HREF="../../../com/perforce/api/EventLog.html#setTitle(java.lang.String)">setTitle</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;title)</CODE>
  239.  
  240. <BR>
  241. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the title for this log.</TD>
  242. </TR>
  243. </TABLE>
  244. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  245. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  246. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  247. <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
  248. </TR>
  249. <TR BGCOLOR="white" CLASS="TableRowColor">
  250. <TD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
  251. </TR>
  252. </TABLE>
  253. &nbsp;
  254. <P>
  255.  
  256. <!-- ============ FIELD DETAIL =========== -->
  257.  
  258.  
  259. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  260.  
  261. <A NAME="constructor_detail"><!-- --></A>
  262. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  263. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  264. <TD COLSPAN=1><FONT SIZE="+2">
  265. <B>Constructor Detail</B></FONT></TD>
  266. </TR>
  267. </TABLE>
  268.  
  269. <A NAME="EventLog()"><!-- --></A><H3>
  270. EventLog</H3>
  271. <PRE>
  272. public <B>EventLog</B>()</PRE>
  273. <DL>
  274. <DD>Default, no-argument constructor. This initialized the Vector of
  275.  events and the date and time format.<DD><DL>
  276. <DT><B>See Also: </B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html"><CODE>Vector</CODE></A></DL>
  277. </DD>
  278. </DL>
  279. <HR>
  280.  
  281. <A NAME="EventLog(java.lang.String)"><!-- --></A><H3>
  282. EventLog</H3>
  283. <PRE>
  284. public <B>EventLog</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;title)</PRE>
  285. <DL>
  286. <DD>Constructor that accepts the title for this. The title is used when
  287.  the webSend() method is invoked.<DD><DL>
  288. <DT><B>Parameters:</B><DD><CODE>title</CODE> - The title for this log.</DL>
  289. </DD>
  290. </DL>
  291. <HR>
  292.  
  293. <A NAME="EventLog(java.lang.String, java.lang.String)"><!-- --></A><H3>
  294. EventLog</H3>
  295. <PRE>
  296. public <B>EventLog</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;title,
  297.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;filename)</PRE>
  298. <DL>
  299. <DD>Constructor that sets the log title and ouput filename.<DD><DL>
  300. <DT><B>Parameters:</B><DD><CODE>title</CODE> - The title for this log.<DD><CODE>filename</CODE> - Name for the output file.</DL>
  301. </DD>
  302. </DL>
  303.  
  304. <!-- ============ METHOD DETAIL ========== -->
  305.  
  306. <A NAME="method_detail"><!-- --></A>
  307. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  308. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  309. <TD COLSPAN=1><FONT SIZE="+2">
  310. <B>Method Detail</B></FONT></TD>
  311. </TR>
  312. </TABLE>
  313.  
  314. <A NAME="commonLog(java.lang.String)"><!-- --></A><H3>
  315. commonLog</H3>
  316. <PRE>
  317. public static void <B>commonLog</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event)</PRE>
  318. <DL>
  319. <DD>Logs an event to the common log. The event passed in is added to the 
  320.  log. If the log is beyond its maximum size, then the oldest events
  321.  are dropped.<DD><DL>
  322. <DT><B>Parameters:</B><DD><CODE>event</CODE> - The event to be logged.</DL>
  323. </DD>
  324. </DL>
  325. <HR>
  326.  
  327. <A NAME="commonLog(java.lang.String, java.lang.String)"><!-- --></A><H3>
  328. commonLog</H3>
  329. <PRE>
  330. public static void <B>commonLog</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  331.                              <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level)</PRE>
  332. <DL>
  333. <DD>Logs an event to the common log. The event passed in is added to the 
  334.  log. If the log is beyond its maximum size, then the oldest events
  335.  are dropped.<DD><DL>
  336. <DT><B>Parameters:</B><DD><CODE>event</CODE> - The event to be logged.<DD><CODE>level</CODE> - Level for the logged event.</DL>
  337. </DD>
  338. </DL>
  339. <HR>
  340.  
  341. <A NAME="commonLog(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
  342. commonLog</H3>
  343. <PRE>
  344. public static void <B>commonLog</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  345.                              <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level,
  346.                              boolean&nbsp;encode)</PRE>
  347. <DL>
  348. <DD>Logs an event to the common log. The event passed in is added to the 
  349.  log. If the log is beyond its maximum size, then the oldest events
  350.  are dropped.<DD><DL>
  351. <DT><B>Parameters:</B><DD><CODE>event</CODE> - The event to be logged.<DD><CODE>level</CODE> - Level for the logged event.<DD><CODE>encode</CODE> - Indicates that the output should be XML/HTML encoded.</DL>
  352. </DD>
  353. </DL>
  354. <HR>
  355.  
  356. <A NAME="getFileName()"><!-- --></A><H3>
  357. getFileName</H3>
  358. <PRE>
  359. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getFileName</B>()</PRE>
  360. <DL>
  361. <DD>Returns the output file name.</DL>
  362. <HR>
  363.  
  364. <A NAME="getLog()"><!-- --></A><H3>
  365. getLog</H3>
  366. <PRE>
  367. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>getLog</B>()</PRE>
  368. <DL>
  369. <DD>Returns an Enumeration that contains all the events in the log.<DD><DL>
  370. <DT><B>Returns:</B><DD>List of Strings in the log.</DL>
  371. </DD>
  372. </DL>
  373. <HR>
  374.  
  375. <A NAME="getSize()"><!-- --></A><H3>
  376. getSize</H3>
  377. <PRE>
  378. public int <B>getSize</B>()</PRE>
  379. <DL>
  380. <DD>Returns the size of the event log memory. This is the maximum number of
  381.  lines that will be maintained in memory.</DL>
  382. <HR>
  383.  
  384. <A NAME="getTitle()"><!-- --></A><H3>
  385. getTitle</H3>
  386. <PRE>
  387. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getTitle</B>()</PRE>
  388. <DL>
  389. <DD>Gets the title of the log.</DL>
  390. <HR>
  391.  
  392. <A NAME="log(java.lang.String)"><!-- --></A><H3>
  393. log</H3>
  394. <PRE>
  395. public void <B>log</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event)</PRE>
  396. <DL>
  397. <DD>Logs an event to this log. The event passed in is added to the 
  398.  log. If the log is beyond its maximum size, then the oldest events
  399.  are dropped.<DD><DL>
  400. <DT><B>Parameters:</B><DD><CODE>event</CODE> - The event to be logged.</DL>
  401. </DD>
  402. </DL>
  403. <HR>
  404.  
  405. <A NAME="log(java.lang.String, java.lang.String)"><!-- --></A><H3>
  406. log</H3>
  407. <PRE>
  408. public void <B>log</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  409.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level)</PRE>
  410. <DL>
  411. <DD>Logs an event to this log. The event passed in is added to the 
  412.  log. If the log is beyond its maximum size, then the oldest events
  413.  are dropped.<DD><DL>
  414. <DT><B>Parameters:</B><DD><CODE>event</CODE> - The event to be logged.<DD><CODE>level</CODE> - Level for the logged event.</DL>
  415. </DD>
  416. </DL>
  417. <HR>
  418.  
  419. <A NAME="log(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
  420. log</H3>
  421. <PRE>
  422. public void <B>log</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;event,
  423.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;level,
  424.                 boolean&nbsp;encode)</PRE>
  425. <DL>
  426. <DD>Logs an event to this log. The event passed in is added to the 
  427.  log. If the log is beyond its maximum size, then the oldest events
  428.  are dropped.<DD><DL>
  429. <DT><B>Parameters:</B><DD><CODE>event</CODE> - The event to be logged.<DD><CODE>level</CODE> - Level for the logged event.<DD><CODE>encode</CODE> - Indicates that the output should be XML/HTML encoded.</DL>
  430. </DD>
  431. </DL>
  432. <HR>
  433.  
  434. <A NAME="printLog(com.perforce.api.EventLog, java.io.PrintWriter, java.lang.String)"><!-- --></A><H3>
  435. printLog</H3>
  436. <PRE>
  437. public static void <B>printLog</B>(<A HREF="../../../com/perforce/api/EventLog.html">EventLog</A>&nbsp;elog,
  438.                             <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/PrintWriter.html">PrintWriter</A>&nbsp;out,
  439.                             <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;format)</PRE>
  440. <DL>
  441. <DD>Prints a log, using the specified format. Each line is placed in
  442.  the format string where {0} occurs.<DD><DL>
  443. <DT><B>Parameters:</B><DD><CODE>elog</CODE> - <code>EventLog</code> to print.<DD><CODE>out</CODE> - Print output.<DD><CODE>format</CODE> - Format to use.<DT><B>See Also: </B><DD><CODE>java.text.MessageFormat</CODE></DL>
  444. </DD>
  445. </DL>
  446. <HR>
  447.  
  448. <A NAME="printLog(java.io.PrintWriter, java.lang.String)"><!-- --></A><H3>
  449. printLog</H3>
  450. <PRE>
  451. public static void <B>printLog</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/PrintWriter.html">PrintWriter</A>&nbsp;out,
  452.                             <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;format)</PRE>
  453. <DL>
  454. <DD>Prints this log, using the specified format. Each line is placed in
  455.  the format string where {0} occurs.<DD><DL>
  456. <DT><B>Parameters:</B><DD><CODE>out</CODE> - Print output.<DD><CODE>format</CODE> - Format to use.<DT><B>See Also: </B><DD><CODE>java.text.MessageFormat</CODE></DL>
  457. </DD>
  458. </DL>
  459. <HR>
  460.  
  461. <A NAME="setSize(int)"><!-- --></A><H3>
  462. setSize</H3>
  463. <PRE>
  464. public void <B>setSize</B>(int&nbsp;size)</PRE>
  465. <DL>
  466. <DD>Sets the size of the log. This is the maximum number of lines that the
  467.  log will maintain in memory.<DD><DL>
  468. <DT><B>Parameters:</B><DD><CODE>size</CODE> - The number of lines to keep in the log.</DL>
  469. </DD>
  470. </DL>
  471. <HR>
  472.  
  473. <A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
  474. setTitle</H3>
  475. <PRE>
  476. public void <B>setTitle</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;title)</PRE>
  477. <DL>
  478. <DD>Sets the title for this log.<DD><DL>
  479. <DT><B>Parameters:</B><DD><CODE>title</CODE> - The title of the log.</DL>
  480. </DD>
  481. </DL>
  482. <!-- ========= END OF CLASS DATA ========= -->
  483. <HR>
  484.  
  485. <!-- ========== START OF NAVBAR ========== -->
  486. <A NAME="navbar_bottom"><!-- --></A>
  487. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  488. <TR>
  489. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  490. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  491. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  492.   <TR ALIGN="center" VALIGN="top">
  493.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  494.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  495.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EventLog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  496.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  497.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  498.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  499.   </TR>
  500. </TABLE>
  501. </TD>
  502. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  503. <a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM>
  504. </TD>
  505. </TR>
  506.  
  507. <TR>
  508. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  509. &nbsp;<A HREF="../../../com/perforce/api/Env.html"><B>PREV CLASS</B></A>&nbsp;
  510. &nbsp;<A HREF="../../../com/perforce/api/FileEntry.html"><B>NEXT CLASS</B></A></FONT></TD>
  511. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  512.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  513. &nbsp;<A HREF="EventLog.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  514. </TR>
  515. <TR>
  516. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  517.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  518. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  519. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  520. </TR>
  521. </TABLE>
  522. <!-- =========== END OF NAVBAR =========== -->
  523.  
  524. <HR>
  525. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  526. </BODY>
  527. </HTML>
# Change User Description Committed
#6 2001 David Markley Updated package documentation. 23 years ago
#5 1387 David Markley Added the ability to reopen files, add them to changelists, and updated the
documentation... to reflect these changes. «		 23 years ago
#4 1360 David Markley Updated Env class. 23 years ago
#3 1332 David Markley Added more example code.
Added the Counter class.
Corrected the filelog methods for the... FileEntry class. «		 23 years ago
#2 1037 David Markley Updated the documentation. 23 years ago
#1 1020 David Markley Added Perforce Java API documentation.
This is generated using JavaDoc. 		23 years ago