Helix SwarmHelix Swarm
Loading...

Counter.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • Counter.html #4
  • View
  • Commits
  • Open Download .zip Download (20 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  Counter
  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/Counter.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/Client.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/Debug.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="Counter.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  Counter</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.   +--<A HREF="../../../com/perforce/api/SourceControlObject.html">com.perforce.api.SourceControlObject</A>
  63.         |
  64.         +--<B>com.perforce.api.Counter</B>
  65. </PRE>
  66. <DL>
  67. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></DD>
  68. </DL>
  69. <HR>
  70. <DL>
  71. <DT>public final class <B>Counter</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></DL>
  72.  
  73. <P>
  74. Representation of perforce counters. This class can be used to set and get
  75.  the value of a counter. It can also be used to determine who reviews the
  76.  changes represented by a particular value.
  77. <P>
  78. <DL>
  79. <DT><B>Version: </B><DD>$Date: 2002/01/16 $ $Revision: #4 $</DD>
  80. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  81. </DL>
  82. <HR>
  83.  
  84. <P>
  85. <!-- ======== INNER CLASS SUMMARY ======== -->
  86.  
  87.  
  88. <!-- =========== FIELD SUMMARY =========== -->
  89.  
  90.  
  91. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  92.  
  93. <A NAME="constructor_summary"><!-- --></A>
  94. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  95. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  96. <TD COLSPAN=2><FONT SIZE="+2">
  97. <B>Constructor Summary</B></FONT></TD>
  98. </TR>
  99. <TR BGCOLOR="white" CLASS="TableRowColor">
  100. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#Counter()">Counter</A></B>()</CODE>
  101.  
  102. <BR>
  103. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default no-argument constructor.</TD>
  104. </TR>
  105. <TR BGCOLOR="white" CLASS="TableRowColor">
  106. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#Counter(com.perforce.api.Env, java.lang.String)">Counter</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;environ,
  107.         <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  108.  
  109. <BR>
  110. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  111. </TR>
  112. <TR BGCOLOR="white" CLASS="TableRowColor">
  113. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#Counter(java.lang.String)">Counter</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  114.  
  115. <BR>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  117. </TR>
  118. </TABLE>
  119. &nbsp;
  120. <!-- ========== METHOD SUMMARY =========== -->
  121.  
  122. <A NAME="method_summary"><!-- --></A>
  123. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  124. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  125. <TD COLSPAN=2><FONT SIZE="+2">
  126. <B>Method Summary</B></FONT></TD>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  130. <CODE>&nbsp;void</CODE></FONT></TD>
  131. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#commit()">commit</A></B>()</CODE>
  132.  
  133. <BR>
  134. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores this object back into Perforce, creating it if it
  135.  didn't already exist.</TD>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  139. <CODE>&nbsp;<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
  140. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#getCache()">getCache</A></B>()</CODE>
  141.  
  142. <BR>
  143. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the HashDecay instance for this class</TD>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  147. <CODE>static&nbsp;<A HREF="../../../com/perforce/api/Counter.html">Counter</A>[]</CODE></FONT></TD>
  148. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#getCounters(com.perforce.api.Env)">getCounters</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  149.  
  150. <BR>
  151. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all the Counters established on the server.</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#getName()">getName</A></B>()</CODE>
  157.  
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  160. </TR>
  161. <TR BGCOLOR="white" CLASS="TableRowColor">
  162. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  163. <CODE>&nbsp;int</CODE></FONT></TD>
  164. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#getValue()">getValue</A></B>()</CODE>
  165.  
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of this Counter.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>&nbsp;<A HREF="../../../com/perforce/api/Change.html">Change</A>[]</CODE></FONT></TD>
  172. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#review()">review</A></B>()</CODE>
  173.  
  174. <BR>
  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine the changelists that need to be reviewed.</TD>
  176. </TR>
  177. <TR BGCOLOR="white" CLASS="TableRowColor">
  178. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  179. <CODE>&nbsp;void</CODE></FONT></TD>
  180. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  181.  
  182. <BR>
  183. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  184. </TR>
  185. <TR BGCOLOR="white" CLASS="TableRowColor">
  186. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  187. <CODE>&nbsp;void</CODE></FONT></TD>
  188. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#setValue(int)">setValue</A></B>(int&nbsp;value)</CODE>
  189.  
  190. <BR>
  191. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value for the Counter.</TD>
  192. </TR>
  193. <TR BGCOLOR="white" CLASS="TableRowColor">
  194. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  195. <CODE>&nbsp;void</CODE></FONT></TD>
  196. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#sync()">sync</A></B>()</CODE>
  197.  
  198. <BR>
  199. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Brings this object back into sync with Perforce.</TD>
  200. </TR>
  201. <TR BGCOLOR="white" CLASS="TableRowColor">
  202. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  203. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  204. <TD><CODE><B><A HREF="../../../com/perforce/api/Counter.html#toXML()">toXML</A></B>()</CODE>
  205.  
  206. <BR>
  207. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
  208. </TR>
  209. </TABLE>
  210. &nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
  211. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  212. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  213. <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD>
  214. </TR>
  215. <TR BGCOLOR="white" CLASS="TableRowColor">
  216. <TD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#clearCache()">clearCache</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getEnv()">getEnv</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getSyncTime()">getSyncTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getUpdateTime()">getUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#inSync()">inSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#invalidate()">invalidate</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#outOfSync(long)">outOfSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#refreshUpdateTime()">refreshUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#setEnv(com.perforce.api.Env)">setEnv</A></CODE></TD>
  217. </TR>
  218. </TABLE>
  219. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  220. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  221. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  222. <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>
  223. </TR>
  224. <TR BGCOLOR="white" CLASS="TableRowColor">
  225. <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>
  226. </TR>
  227. </TABLE>
  228. &nbsp;
  229. <P>
  230.  
  231. <!-- ============ FIELD DETAIL =========== -->
  232.  
  233.  
  234. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  235.  
  236. <A NAME="constructor_detail"><!-- --></A>
  237. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  238. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  239. <TD COLSPAN=1><FONT SIZE="+2">
  240. <B>Constructor Detail</B></FONT></TD>
  241. </TR>
  242. </TABLE>
  243.  
  244. <A NAME="Counter()"><!-- --></A><H3>
  245. Counter</H3>
  246. <PRE>
  247. public <B>Counter</B>()</PRE>
  248. <DL>
  249. <DD>Default no-argument constructor.</DL>
  250. <HR>
  251.  
  252. <A NAME="Counter(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
  253. Counter</H3>
  254. <PRE>
  255. public <B>Counter</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;environ,
  256.                <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  257. <DL>
  258. </DL>
  259. <HR>
  260.  
  261. <A NAME="Counter(java.lang.String)"><!-- --></A><H3>
  262. Counter</H3>
  263. <PRE>
  264. public <B>Counter</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  265. <DL>
  266. </DL>
  267.  
  268. <!-- ============ METHOD DETAIL ========== -->
  269.  
  270. <A NAME="method_detail"><!-- --></A>
  271. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  272. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  273. <TD COLSPAN=1><FONT SIZE="+2">
  274. <B>Method Detail</B></FONT></TD>
  275. </TR>
  276. </TABLE>
  277.  
  278. <A NAME="commit()"><!-- --></A><H3>
  279. commit</H3>
  280. <PRE>
  281. public void <B>commit</B>()
  282.             throws <A HREF="../../../com/perforce/api/CommitException.html">CommitException</A></PRE>
  283. <DL>
  284. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  285. <DD>Stores this object back into Perforce, creating it if it
  286.  didn't already exist.<DD><DL>
  287. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  288. </DD>
  289. </DL>
  290. <HR>
  291.  
  292. <A NAME="getCache()"><!-- --></A><H3>
  293. getCache</H3>
  294. <PRE>
  295. public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
  296. <DL>
  297. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  298. <DD>Returns the HashDecay instance for this class<DD><DL>
  299. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">getCache</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  300. </DD>
  301. </DL>
  302. <HR>
  303.  
  304. <A NAME="getCounters(com.perforce.api.Env)"><!-- --></A><H3>
  305. getCounters</H3>
  306. <PRE>
  307. public static <A HREF="../../../com/perforce/api/Counter.html">Counter</A>[] <B>getCounters</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)
  308.                              throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  309. <DL>
  310. <DD>Returns an array of all the Counters established on the server.</DL>
  311. <HR>
  312.  
  313. <A NAME="getName()"><!-- --></A><H3>
  314. getName</H3>
  315. <PRE>
  316. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
  317. <DL>
  318. </DL>
  319. <HR>
  320.  
  321. <A NAME="getValue()"><!-- --></A><H3>
  322. getValue</H3>
  323. <PRE>
  324. public int <B>getValue</B>()</PRE>
  325. <DL>
  326. <DD>Returns the value of this Counter.</DL>
  327. <HR>
  328.  
  329. <A NAME="review()"><!-- --></A><H3>
  330. review</H3>
  331. <PRE>
  332. public <A HREF="../../../com/perforce/api/Change.html">Change</A>[] <B>review</B>()
  333.                 throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  334. <DL>
  335. <DD>Determine the changelists that need to be reviewed. This method
  336.  returns an array of Changes that need to be reviewed.</DL>
  337. <HR>
  338.  
  339. <A NAME="setName(java.lang.String)"><!-- --></A><H3>
  340. setName</H3>
  341. <PRE>
  342. public void <B>setName</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  343. <DL>
  344. </DL>
  345. <HR>
  346.  
  347. <A NAME="setValue(int)"><!-- --></A><H3>
  348. setValue</H3>
  349. <PRE>
  350. public void <B>setValue</B>(int&nbsp;value)</PRE>
  351. <DL>
  352. <DD>Sets the value for the Counter.<DD><DL>
  353. <DT><B>Parameters:</B><DD><CODE>value</CODE> - New counter value</DL>
  354. </DD>
  355. </DL>
  356. <HR>
  357.  
  358. <A NAME="sync()"><!-- --></A><H3>
  359. sync</H3>
  360. <PRE>
  361. public void <B>sync</B>()
  362.           throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  363. <DL>
  364. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  365. <DD>Brings this object back into sync with Perforce. This also sets the
  366.  sets the update and sync time for this object.<DD><DL>
  367. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  368. </DD>
  369. </DL>
  370. <HR>
  371.  
  372. <A NAME="toXML()"><!-- --></A><H3>
  373. toXML</H3>
  374. <PRE>
  375. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  376. <DL>
  377. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  378. <DD>Returns a string containing the object in XML form.<DD><DL>
  379. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  380. </DD>
  381. </DL>
  382. <!-- ========= END OF CLASS DATA ========= -->
  383. <HR>
  384.  
  385. <!-- ========== START OF NAVBAR ========== -->
  386. <A NAME="navbar_bottom"><!-- --></A>
  387. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  388. <TR>
  389. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  390. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  391. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  392.   <TR ALIGN="center" VALIGN="top">
  393.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  394.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  395.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Counter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  396.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  397.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  398.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  399.   </TR>
  400. </TABLE>
  401. </TD>
  402. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  403. <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>
  404. </TD>
  405. </TR>
  406.  
  407. <TR>
  408. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  409. &nbsp;<A HREF="../../../com/perforce/api/Client.html"><B>PREV CLASS</B></A>&nbsp;
  410. &nbsp;<A HREF="../../../com/perforce/api/Debug.html"><B>NEXT CLASS</B></A></FONT></TD>
  411. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  412.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  413. &nbsp;<A HREF="Counter.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  414. </TR>
  415. <TR>
  416. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  417.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  418. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  419. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  420. </TR>
  421. </TABLE>
  422. <!-- =========== END OF NAVBAR =========== -->
  423.  
  424. <HR>
  425. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  426. </BODY>
  427. </HTML>
# Change User Description Committed
#4 2001 David Markley Updated package documentation. 23 years ago
#3 1387 David Markley Added the ability to reopen files, add them to changelists, and updated the
documentation... to reflect these changes. «		 23 years ago
#2 1360 David Markley Updated Env class. 23 years ago
#1 1333 David Markley Documentation for the Counter class was missed. 23 years ago