Helix SwarmHelix Swarm

SourceControlObject.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • SourceControlObject.html #6
  • View
  • Commits
  • Open Download .zip Download (21 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  SourceControlObject
  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/SourceControlObject.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;PREV CLASS&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/User.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="SourceControlObject.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  SourceControlObject</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.SourceControlObject</B>
  63. </PRE>
  64. <DL>
  65. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></DD>
  66. </DL>
  67. <DL>
  68. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/perforce/api/Change.html">Change</A>, <A HREF="../../../com/perforce/api/Counter.html">Counter</A>, <A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A>, <A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>, <A HREF="../../../com/perforce/api/Job.html">Job</A>, <A HREF="../../../com/perforce/api/Mapping.html">Mapping</A>, <A HREF="../../../com/perforce/api/User.html">User</A></DD>
  69. </DL>
  70. <HR>
  71. <DL>
  72. <DT>public abstract class <B>SourceControlObject</B><DT>extends <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A><DT>implements <A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></DL>
  73.  
  74. <P>
  75. An abstract base class for all source control objects.
  76. <P>
  77. <DL>
  78. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #6 $</DD>
  79. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  80. </DL>
  81. <HR>
  82.  
  83. <P>
  84. <!-- ======== INNER CLASS SUMMARY ======== -->
  85.  
  86.  
  87. <!-- =========== FIELD SUMMARY =========== -->
  88.  
  89.  
  90. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  91.  
  92. <A NAME="constructor_summary"><!-- --></A>
  93. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  94. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  95. <TD COLSPAN=2><FONT SIZE="+2">
  96. <B>Constructor Summary</B></FONT></TD>
  97. </TR>
  98. <TR BGCOLOR="white" CLASS="TableRowColor">
  99. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#SourceControlObject()">SourceControlObject</A></B>()</CODE>
  100.  
  101. <BR>
  102. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default, no-argument constructor.</TD>
  103. </TR>
  104. <TR BGCOLOR="white" CLASS="TableRowColor">
  105. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#SourceControlObject(com.perforce.api.Env)">SourceControlObject</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  106.  
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that takes an environment for this object to use.</TD>
  109. </TR>
  110. </TABLE>
  111. &nbsp;
  112. <!-- ========== METHOD SUMMARY =========== -->
  113.  
  114. <A NAME="method_summary"><!-- --></A>
  115. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  116. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  117. <TD COLSPAN=2><FONT SIZE="+2">
  118. <B>Method Summary</B></FONT></TD>
  119. </TR>
  120. <TR BGCOLOR="white" CLASS="TableRowColor">
  121. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  122. <CODE>&nbsp;void</CODE></FONT></TD>
  123. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#clearCache()">clearCache</A></B>()</CODE>
  124.  
  125. <BR>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes any cached objects.</TD>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  130. <CODE>abstract &nbsp;void</CODE></FONT></TD>
  131. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.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>abstract &nbsp;<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
  140. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.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>&nbsp;<A HREF="../../../com/perforce/api/Env.html">Env</A></CODE></FONT></TD>
  148. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#getEnv()">getEnv</A></B>()</CODE>
  149.  
  150. <BR>
  151. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the P4 environment associated with this instance.</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>&nbsp;long</CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#getSyncTime()">getSyncTime</A></B>()</CODE>
  157.  
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the time, in milliseconds, that this object was synchronized.</TD>
  160. </TR>
  161. <TR BGCOLOR="white" CLASS="TableRowColor">
  162. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  163. <CODE>&nbsp;long</CODE></FONT></TD>
  164. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#getUpdateTime()">getUpdateTime</A></B>()</CODE>
  165.  
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the time, in milliseconds, for this object's last update.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>&nbsp;void</CODE></FONT></TD>
  172. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#inSync()">inSync</A></B>()</CODE>
  173.  
  174. <BR>
  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Marks this object as being in in sync or valid.</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/SourceControlObject.html#invalidate()">invalidate</A></B>()</CODE>
  181.  
  182. <BR>
  183. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invalidates this object.</TD>
  184. </TR>
  185. <TR BGCOLOR="white" CLASS="TableRowColor">
  186. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  187. <CODE>&nbsp;boolean</CODE></FONT></TD>
  188. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#outOfSync(long)">outOfSync</A></B>(long&nbsp;threshold)</CODE>
  189.  
  190. <BR>
  191. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests this object to see if it is out of sync.</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/SourceControlObject.html#refreshUpdateTime()">refreshUpdateTime</A></B>()</CODE>
  197.  
  198. <BR>
  199. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the update time for this object to the current time.</TD>
  200. </TR>
  201. <TR BGCOLOR="white" CLASS="TableRowColor">
  202. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  203. <CODE>&nbsp;void</CODE></FONT></TD>
  204. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#setEnv(com.perforce.api.Env)">setEnv</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  205.  
  206. <BR>
  207. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the P4 environment to be used when working with this object.</TD>
  208. </TR>
  209. <TR BGCOLOR="white" CLASS="TableRowColor">
  210. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  211. <CODE>abstract &nbsp;void</CODE></FONT></TD>
  212. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></B>()</CODE>
  213.  
  214. <BR>
  215. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Brings this object back into sync with Perforce.</TD>
  216. </TR>
  217. <TR BGCOLOR="white" CLASS="TableRowColor">
  218. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  219. <CODE>abstract &nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  220. <TD><CODE><B><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></B>()</CODE>
  221.  
  222. <BR>
  223. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
  224. </TR>
  225. </TABLE>
  226. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  227. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  228. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  229. <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>
  230. </TR>
  231. <TR BGCOLOR="white" CLASS="TableRowColor">
  232. <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>
  233. </TR>
  234. </TABLE>
  235. &nbsp;
  236. <P>
  237.  
  238. <!-- ============ FIELD DETAIL =========== -->
  239.  
  240.  
  241. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  242.  
  243. <A NAME="constructor_detail"><!-- --></A>
  244. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  245. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  246. <TD COLSPAN=1><FONT SIZE="+2">
  247. <B>Constructor Detail</B></FONT></TD>
  248. </TR>
  249. </TABLE>
  250.  
  251. <A NAME="SourceControlObject()"><!-- --></A><H3>
  252. SourceControlObject</H3>
  253. <PRE>
  254. public <B>SourceControlObject</B>()</PRE>
  255. <DL>
  256. <DD>Default, no-argument constructor.</DL>
  257. <HR>
  258.  
  259. <A NAME="SourceControlObject(com.perforce.api.Env)"><!-- --></A><H3>
  260. SourceControlObject</H3>
  261. <PRE>
  262. public <B>SourceControlObject</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  263. <DL>
  264. <DD>Constructor that takes an environment for this object to use.<DD><DL>
  265. <DT><B>Parameters:</B><DD><CODE>env</CODE> - source control environement to use.</DL>
  266. </DD>
  267. </DL>
  268.  
  269. <!-- ============ METHOD DETAIL ========== -->
  270.  
  271. <A NAME="method_detail"><!-- --></A>
  272. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  273. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  274. <TD COLSPAN=1><FONT SIZE="+2">
  275. <B>Method Detail</B></FONT></TD>
  276. </TR>
  277. </TABLE>
  278.  
  279. <A NAME="clearCache()"><!-- --></A><H3>
  280. clearCache</H3>
  281. <PRE>
  282. public void <B>clearCache</B>()</PRE>
  283. <DL>
  284. <DD>Removes any cached objects.<DD><DL>
  285. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#clearCache()">clearCache</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  286. </DD>
  287. </DL>
  288. <HR>
  289.  
  290. <A NAME="commit()"><!-- --></A><H3>
  291. commit</H3>
  292. <PRE>
  293. public abstract void <B>commit</B>()
  294.                      throws <A HREF="../../../com/perforce/api/CommitException.html">CommitException</A></PRE>
  295. <DL>
  296. <DD>Stores this object back into Perforce, creating it if it
  297.  didn't already exist.<DD><DL>
  298. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#commit()">commit</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  299. </DD>
  300. </DL>
  301. <HR>
  302.  
  303. <A NAME="getCache()"><!-- --></A><H3>
  304. getCache</H3>
  305. <PRE>
  306. public abstract <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
  307. <DL>
  308. <DD>Returns the HashDecay instance for this class<DD><DL>
  309. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#getCache()">getCache</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  310. </DD>
  311. </DL>
  312. <HR>
  313.  
  314. <A NAME="getEnv()"><!-- --></A><H3>
  315. getEnv</H3>
  316. <PRE>
  317. public <A HREF="../../../com/perforce/api/Env.html">Env</A> <B>getEnv</B>()</PRE>
  318. <DL>
  319. <DD>Returns the P4 environment associated with this instance.<DD><DL>
  320. </DL>
  321. </DD>
  322. <DD><DL>
  323. <DT><B>Returns:</B><DD>P4 environment.</DL>
  324. </DD>
  325. </DL>
  326. <HR>
  327.  
  328. <A NAME="getSyncTime()"><!-- --></A><H3>
  329. getSyncTime</H3>
  330. <PRE>
  331. public long <B>getSyncTime</B>()</PRE>
  332. <DL>
  333. <DD>Returns the time, in milliseconds, that this object was synchronized.<DD><DL>
  334. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#getSyncTime()">getSyncTime</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  335. </DD>
  336. </DL>
  337. <HR>
  338.  
  339. <A NAME="getUpdateTime()"><!-- --></A><H3>
  340. getUpdateTime</H3>
  341. <PRE>
  342. public long <B>getUpdateTime</B>()</PRE>
  343. <DL>
  344. <DD>Returns the time, in milliseconds, for this object's last update.<DD><DL>
  345. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#getUpdateTime()">getUpdateTime</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  346. </DD>
  347. </DL>
  348. <HR>
  349.  
  350. <A NAME="inSync()"><!-- --></A><H3>
  351. inSync</H3>
  352. <PRE>
  353. public void <B>inSync</B>()</PRE>
  354. <DL>
  355. <DD>Marks this object as being in in sync or valid.<DD><DL>
  356. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#inSync()">inSync</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  357. </DD>
  358. </DL>
  359. <HR>
  360.  
  361. <A NAME="invalidate()"><!-- --></A><H3>
  362. invalidate</H3>
  363. <PRE>
  364. public void <B>invalidate</B>()</PRE>
  365. <DL>
  366. <DD>Invalidates this object.<DD><DL>
  367. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#invalidate()">invalidate</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  368. </DD>
  369. </DL>
  370. <HR>
  371.  
  372. <A NAME="outOfSync(long)"><!-- --></A><H3>
  373. outOfSync</H3>
  374. <PRE>
  375. public boolean <B>outOfSync</B>(long&nbsp;threshold)</PRE>
  376. <DL>
  377. <DD>Tests this object to see if it is out of sync. Checks to see if the
  378.  expiration time is within the specified number of milliseconds.<DD><DL>
  379. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#outOfSync(long)">outOfSync</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  380. </DD>
  381. <DD><DL>
  382. <DT><B>Parameters:</B><DD><CODE>threshold</CODE> - Number of milliseconds.<DT><B>Returns:</B><DD>True if the object will be out of sync within the threshold.</DL>
  383. </DD>
  384. </DL>
  385. <HR>
  386.  
  387. <A NAME="refreshUpdateTime()"><!-- --></A><H3>
  388. refreshUpdateTime</H3>
  389. <PRE>
  390. public void <B>refreshUpdateTime</B>()</PRE>
  391. <DL>
  392. <DD>Sets the update time for this object to the current time.<DD><DL>
  393. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#refreshUpdateTime()">refreshUpdateTime</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  394. </DD>
  395. </DL>
  396. <HR>
  397.  
  398. <A NAME="setEnv(com.perforce.api.Env)"><!-- --></A><H3>
  399. setEnv</H3>
  400. <PRE>
  401. public void <B>setEnv</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  402. <DL>
  403. <DD>Sets the P4 environment to be used when working with this object. This
  404.  environment is required to store, sync, or otherwise work with the
  405.  P4 depot. It is passed to the P4Process used in each of these
  406.  transactions.<DD><DL>
  407. </DL>
  408. </DD>
  409. <DD><DL>
  410. <DT><B>Parameters:</B><DD><CODE>env</CODE> - user environment to use.<DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Env.html"><CODE>Env</CODE></A>, 
  411. <A HREF="../../../com/perforce/api/P4Process.html"><CODE>P4Process</CODE></A></DL>
  412. </DD>
  413. </DL>
  414. <HR>
  415.  
  416. <A NAME="sync()"><!-- --></A><H3>
  417. sync</H3>
  418. <PRE>
  419. public abstract void <B>sync</B>()
  420.                    throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  421. <DL>
  422. <DD>Brings this object back into sync with Perforce. This also sets the
  423.  sets the update and sync time for this object.<DD><DL>
  424. <DT><B>Specified by: </B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#sync()">sync</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></CODE></DL>
  425. </DD>
  426. </DL>
  427. <HR>
  428.  
  429. <A NAME="toXML()"><!-- --></A><H3>
  430. toXML</H3>
  431. <PRE>
  432. public abstract <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  433. <DL>
  434. <DD>Returns a string containing the object in XML form.<DD><DL>
  435. </DL>
  436. </DD>
  437. </DL>
  438. <!-- ========= END OF CLASS DATA ========= -->
  439. <HR>
  440.  
  441. <!-- ========== START OF NAVBAR ========== -->
  442. <A NAME="navbar_bottom"><!-- --></A>
  443. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  444. <TR>
  445. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  446. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  447. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  448.   <TR ALIGN="center" VALIGN="top">
  449.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  450.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  451.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SourceControlObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  452.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  453.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  454.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  455.   </TR>
  456. </TABLE>
  457. </TD>
  458. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  459. <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>
  460. </TD>
  461. </TR>
  462.  
  463. <TR>
  464. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  465. &nbsp;PREV CLASS&nbsp;
  466. &nbsp;<A HREF="../../../com/perforce/api/User.html"><B>NEXT CLASS</B></A></FONT></TD>
  467. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  468.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  469. &nbsp;<A HREF="SourceControlObject.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  470. </TR>
  471. <TR>
  472. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  473.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  474. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  475. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  476. </TR>
  477. </TABLE>
  478. <!-- =========== END OF NAVBAR =========== -->
  479.  
  480. <HR>
  481. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  482. </BODY>
  483. </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