Helix SwarmHelix Swarm

Cacheable.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • Cacheable.html #6
  • View
  • Commits
  • Open Download .zip Download (12 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: Interface  Cacheable
  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/Cacheable.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;NEXT CLASS</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="Cacheable.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;CONSTR&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;CONSTR&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. Interface  Cacheable</H2>
  59. <DL>
  60. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></DD>
  61. </DL>
  62. <HR>
  63. <DL>
  64. <DT>public interface <B>Cacheable</B></DL>
  65.  
  66. <P>
  67. An interface that indicates the implementing class can be cached for some
  68.  period of time. Implementing classes will be stored in a
  69.  <code>HashDecay</code> instance. Each instantiating class must create its
  70.  own <code>HashDecay</code> instance and return a reference to it through 
  71.  the <code>getCache</code> method.
  72.  
  73.  The update time is what is used by the <code>HasDecay</code> to determine
  74.  when an object will decay and be discarded.
  75. <P>
  76. <DL>
  77. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #6 $</DD>
  78. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  79. <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/HashDecay.html"><CODE>HashDecay</CODE></A></DL>
  80. <HR>
  81.  
  82. <P>
  83. <!-- ======== INNER CLASS SUMMARY ======== -->
  84.  
  85.  
  86. <!-- =========== FIELD SUMMARY =========== -->
  87.  
  88.  
  89. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  90.  
  91.  
  92. <!-- ========== METHOD SUMMARY =========== -->
  93.  
  94. <A NAME="method_summary"><!-- --></A>
  95. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  96. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  97. <TD COLSPAN=2><FONT SIZE="+2">
  98. <B>Method Summary</B></FONT></TD>
  99. </TR>
  100. <TR BGCOLOR="white" CLASS="TableRowColor">
  101. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  102. <CODE>&nbsp;void</CODE></FONT></TD>
  103. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#clearCache()">clearCache</A></B>()</CODE>
  104.  
  105. <BR>
  106. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes any cached objects.</TD>
  107. </TR>
  108. <TR BGCOLOR="white" CLASS="TableRowColor">
  109. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  110. <CODE>&nbsp;void</CODE></FONT></TD>
  111. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#commit()">commit</A></B>()</CODE>
  112.  
  113. <BR>
  114. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores this object back into Perforce, creating it if it
  115.  didn't already exist.</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  119. <CODE>&nbsp;<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
  120. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#getCache()">getCache</A></B>()</CODE>
  121.  
  122. <BR>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the HashDecay instance for this class</TD>
  124. </TR>
  125. <TR BGCOLOR="white" CLASS="TableRowColor">
  126. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  127. <CODE>&nbsp;long</CODE></FONT></TD>
  128. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#getSyncTime()">getSyncTime</A></B>()</CODE>
  129.  
  130. <BR>
  131. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the time, in milliseconds, that this object was synchronized.</TD>
  132. </TR>
  133. <TR BGCOLOR="white" CLASS="TableRowColor">
  134. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  135. <CODE>&nbsp;long</CODE></FONT></TD>
  136. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#getUpdateTime()">getUpdateTime</A></B>()</CODE>
  137.  
  138. <BR>
  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the time, in milliseconds, for this object's last update.</TD>
  140. </TR>
  141. <TR BGCOLOR="white" CLASS="TableRowColor">
  142. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  143. <CODE>&nbsp;void</CODE></FONT></TD>
  144. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#inSync()">inSync</A></B>()</CODE>
  145.  
  146. <BR>
  147. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Marks this object as being in in sync or valid.</TD>
  148. </TR>
  149. <TR BGCOLOR="white" CLASS="TableRowColor">
  150. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  151. <CODE>&nbsp;void</CODE></FONT></TD>
  152. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#invalidate()">invalidate</A></B>()</CODE>
  153.  
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invalidates this object.</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>&nbsp;boolean</CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#outOfSync(long)">outOfSync</A></B>(long&nbsp;threshold)</CODE>
  161.  
  162. <BR>
  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests this object to see if it is out of sync.</TD>
  164. </TR>
  165. <TR BGCOLOR="white" CLASS="TableRowColor">
  166. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  167. <CODE>&nbsp;void</CODE></FONT></TD>
  168. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#refreshUpdateTime()">refreshUpdateTime</A></B>()</CODE>
  169.  
  170. <BR>
  171. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the update time for this object to the current time.</TD>
  172. </TR>
  173. <TR BGCOLOR="white" CLASS="TableRowColor">
  174. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  175. <CODE>&nbsp;void</CODE></FONT></TD>
  176. <TD><CODE><B><A HREF="../../../com/perforce/api/Cacheable.html#sync()">sync</A></B>()</CODE>
  177.  
  178. <BR>
  179. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Brings this object back into sync with Perforce.</TD>
  180. </TR>
  181. </TABLE>
  182. &nbsp;
  183. <P>
  184.  
  185. <!-- ============ FIELD DETAIL =========== -->
  186.  
  187.  
  188. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  189.  
  190.  
  191. <!-- ============ METHOD DETAIL ========== -->
  192.  
  193. <A NAME="method_detail"><!-- --></A>
  194. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  195. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  196. <TD COLSPAN=1><FONT SIZE="+2">
  197. <B>Method Detail</B></FONT></TD>
  198. </TR>
  199. </TABLE>
  200.  
  201. <A NAME="clearCache()"><!-- --></A><H3>
  202. clearCache</H3>
  203. <PRE>
  204. public void <B>clearCache</B>()</PRE>
  205. <DL>
  206. <DD>Removes any cached objects.</DL>
  207. <HR>
  208.  
  209. <A NAME="commit()"><!-- --></A><H3>
  210. commit</H3>
  211. <PRE>
  212. public void <B>commit</B>()
  213.             throws <A HREF="../../../com/perforce/api/CommitException.html">CommitException</A></PRE>
  214. <DL>
  215. <DD>Stores this object back into Perforce, creating it if it
  216.  didn't already exist.</DL>
  217. <HR>
  218.  
  219. <A NAME="getCache()"><!-- --></A><H3>
  220. getCache</H3>
  221. <PRE>
  222. public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
  223. <DL>
  224. <DD>Returns the HashDecay instance for this class</DL>
  225. <HR>
  226.  
  227. <A NAME="getSyncTime()"><!-- --></A><H3>
  228. getSyncTime</H3>
  229. <PRE>
  230. public long <B>getSyncTime</B>()</PRE>
  231. <DL>
  232. <DD>Returns the time, in milliseconds, that this object was synchronized.</DL>
  233. <HR>
  234.  
  235. <A NAME="getUpdateTime()"><!-- --></A><H3>
  236. getUpdateTime</H3>
  237. <PRE>
  238. public long <B>getUpdateTime</B>()</PRE>
  239. <DL>
  240. <DD>Returns the time, in milliseconds, for this object's last update.</DL>
  241. <HR>
  242.  
  243. <A NAME="inSync()"><!-- --></A><H3>
  244. inSync</H3>
  245. <PRE>
  246. public void <B>inSync</B>()</PRE>
  247. <DL>
  248. <DD>Marks this object as being in in sync or valid.</DL>
  249. <HR>
  250.  
  251. <A NAME="invalidate()"><!-- --></A><H3>
  252. invalidate</H3>
  253. <PRE>
  254. public void <B>invalidate</B>()</PRE>
  255. <DL>
  256. <DD>Invalidates this object.</DL>
  257. <HR>
  258.  
  259. <A NAME="outOfSync(long)"><!-- --></A><H3>
  260. outOfSync</H3>
  261. <PRE>
  262. public boolean <B>outOfSync</B>(long&nbsp;threshold)</PRE>
  263. <DL>
  264. <DD>Tests this object to see if it is out of sync. Checks to see if the
  265.  expiration time is within the specified number of milliseconds.<DD><DL>
  266. <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>
  267. </DD>
  268. </DL>
  269. <HR>
  270.  
  271. <A NAME="refreshUpdateTime()"><!-- --></A><H3>
  272. refreshUpdateTime</H3>
  273. <PRE>
  274. public void <B>refreshUpdateTime</B>()</PRE>
  275. <DL>
  276. <DD>Sets the update time for this object to the current time.</DL>
  277. <HR>
  278.  
  279. <A NAME="sync()"><!-- --></A><H3>
  280. sync</H3>
  281. <PRE>
  282. public void <B>sync</B>()
  283.           throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  284. <DL>
  285. <DD>Brings this object back into sync with Perforce. This also sets the
  286.  sets the update and sync time for this object.</DL>
  287. <!-- ========= END OF CLASS DATA ========= -->
  288. <HR>
  289.  
  290. <!-- ========== START OF NAVBAR ========== -->
  291. <A NAME="navbar_bottom"><!-- --></A>
  292. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  293. <TR>
  294. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  295. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  296. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  297.   <TR ALIGN="center" VALIGN="top">
  298.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  299.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  300.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Cacheable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  301.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  302.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  303.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  304.   </TR>
  305. </TABLE>
  306. </TD>
  307. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  308. <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>
  309. </TD>
  310. </TR>
  311.  
  312. <TR>
  313. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  314. &nbsp;PREV CLASS&nbsp;
  315. &nbsp;NEXT CLASS</FONT></TD>
  316. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  317.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  318. &nbsp;<A HREF="Cacheable.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  319. </TR>
  320. <TR>
  321. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  322.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  323. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  324. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  325. </TR>
  326. </TABLE>
  327. <!-- =========== END OF NAVBAR =========== -->
  328.  
  329. <HR>
  330. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  331. </BODY>
  332. </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