Helix SwarmHelix Swarm

DirEntry.html

  • //
  • guest/
  • nicholas_veeser/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • DirEntry.html #1
  • 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  DirEntry
  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/DirEntry.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/Debug.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/Env.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="DirEntry.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  DirEntry</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.DirEntry</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>DirEntry</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></DL>
  72.  
  73. <P>
  74. Representation of a source control directory.
  75. <P>
  76. <DL>
  77. <DT><B>Version: </B><DD>$Date: 2003/09/05 $ $Revision: #1 $</DD>
  78. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  79. </DL>
  80. <HR>
  81.  
  82. <P>
  83. <!-- ======== INNER CLASS SUMMARY ======== -->
  84.  
  85.  
  86. <!-- =========== FIELD SUMMARY =========== -->
  87.  
  88.  
  89. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  90.  
  91. <A NAME="constructor_summary"><!-- --></A>
  92. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  93. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  94. <TD COLSPAN=2><FONT SIZE="+2">
  95. <B>Constructor Summary</B></FONT></TD>
  96. </TR>
  97. <TR BGCOLOR="white" CLASS="TableRowColor">
  98. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry()">DirEntry</A></B>()</CODE>
  99.  
  100. <BR>
  101. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default, no-argument constructor.</TD>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry(com.perforce.api.DirEntry, java.lang.String)">DirEntry</A></B>(<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A>&nbsp;base,
  105.          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
  106.  
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a directory entry.</TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry(com.perforce.api.Env)">DirEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</CODE>
  112.  
  113. <BR>
  114. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a directory entry.</TD>
  115. </TR>
  116. <TR BGCOLOR="white" CLASS="TableRowColor">
  117. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry(com.perforce.api.Env, java.lang.String)">DirEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e,
  118.          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
  119.  
  120. <BR>
  121. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a directory entry.</TD>
  122. </TR>
  123. </TABLE>
  124. &nbsp;
  125. <!-- ========== METHOD SUMMARY =========== -->
  126.  
  127. <A NAME="method_summary"><!-- --></A>
  128. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  129. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  130. <TD COLSPAN=2><FONT SIZE="+2">
  131. <B>Method Summary</B></FONT></TD>
  132. </TR>
  133. <TR BGCOLOR="white" CLASS="TableRowColor">
  134. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  135. <CODE>&nbsp;void</CODE></FONT></TD>
  136. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#commit()">commit</A></B>()</CODE>
  137.  
  138. <BR>
  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Does nothing.</TD>
  140. </TR>
  141. <TR BGCOLOR="white" CLASS="TableRowColor">
  142. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  143. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  144. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getBasePath()">getBasePath</A></B>()</CODE>
  145.  
  146. <BR>
  147. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the base path for this directory.</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="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
  152. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getCache()">getCache</A></B>()</CODE>
  153.  
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the HashDecay instance for this class</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>static&nbsp;<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A></CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getDirEntry(com.perforce.api.Env, java.lang.String, boolean)">getDirEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
  161.             <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path,
  162.             boolean&nbsp;sync)</CODE>
  163.  
  164. <BR>
  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a directory entry for the supplied path.</TD>
  166. </TR>
  167. <TR BGCOLOR="white" CLASS="TableRowColor">
  168. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  169. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
  170. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getDirNames()">getDirNames</A></B>()</CODE>
  171.  
  172. <BR>
  173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of directory names.</TD>
  174. </TR>
  175. <TR BGCOLOR="white" CLASS="TableRowColor">
  176. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  177. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
  178. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getDirNames(com.perforce.api.Env)">getDirNames</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  179.  
  180. <BR>
  181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of directory names.</TD>
  182. </TR>
  183. <TR BGCOLOR="white" CLASS="TableRowColor">
  184. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  185. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
  186. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFileNames()">getFileNames</A></B>()</CODE>
  187.  
  188. <BR>
  189. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file names for this directory.</TD>
  190. </TR>
  191. <TR BGCOLOR="white" CLASS="TableRowColor">
  192. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  193. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
  194. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFileNames(com.perforce.api.Env)">getFileNames</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  195.  
  196. <BR>
  197. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file names for this directory.</TD>
  198. </TR>
  199. <TR BGCOLOR="white" CLASS="TableRowColor">
  200. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  201. <CODE>&nbsp;<A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[]</CODE></FONT></TD>
  202. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFiles()">getFiles</A></B>()</CODE>
  203.  
  204. <BR>
  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file entries for this directory.</TD>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  209. <CODE>&nbsp;<A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[]</CODE></FONT></TD>
  210. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFiles(com.perforce.api.Env)">getFiles</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>
  211.  
  212. <BR>
  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file entries for this directory.</TD>
  214. </TR>
  215. <TR BGCOLOR="white" CLASS="TableRowColor">
  216. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  217. <CODE>&nbsp;<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A></CODE></FONT></TD>
  218. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getParent()">getParent</A></B>()</CODE>
  219.  
  220. <BR>
  221. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the parent director.</TD>
  222. </TR>
  223. <TR BGCOLOR="white" CLASS="TableRowColor">
  224. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  225. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  226. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getPath()">getPath</A></B>()</CODE>
  227.  
  228. <BR>
  229. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the path for this directory.</TD>
  230. </TR>
  231. <TR BGCOLOR="white" CLASS="TableRowColor">
  232. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  233. <CODE>&nbsp;void</CODE></FONT></TD>
  234. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#setPath(java.lang.String)">setPath</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
  235.  
  236. <BR>
  237. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the path for this directory.</TD>
  238. </TR>
  239. <TR BGCOLOR="white" CLASS="TableRowColor">
  240. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  241. <CODE>&nbsp;void</CODE></FONT></TD>
  242. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#sync()">sync</A></B>()</CODE>
  243.  
  244. <BR>
  245. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the directories and files for this directory.</TD>
  246. </TR>
  247. <TR BGCOLOR="white" CLASS="TableRowColor">
  248. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  249. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  250. <TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#toXML()">toXML</A></B>()</CODE>
  251.  
  252. <BR>
  253. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
  254. </TR>
  255. </TABLE>
  256. &nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
  257. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  258. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  259. <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD>
  260. </TR>
  261. <TR BGCOLOR="white" CLASS="TableRowColor">
  262. <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>
  263. </TR>
  264. </TABLE>
  265. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  266. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  267. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  268. <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>
  269. </TR>
  270. <TR BGCOLOR="white" CLASS="TableRowColor">
  271. <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>
  272. </TR>
  273. </TABLE>
  274. &nbsp;
  275. <P>
  276.  
  277. <!-- ============ FIELD DETAIL =========== -->
  278.  
  279.  
  280. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  281.  
  282. <A NAME="constructor_detail"><!-- --></A>
  283. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  284. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  285. <TD COLSPAN=1><FONT SIZE="+2">
  286. <B>Constructor Detail</B></FONT></TD>
  287. </TR>
  288. </TABLE>
  289.  
  290. <A NAME="DirEntry()"><!-- --></A><H3>
  291. DirEntry</H3>
  292. <PRE>
  293. public <B>DirEntry</B>()</PRE>
  294. <DL>
  295. <DD>Default, no-argument constructor.</DL>
  296. <HR>
  297.  
  298. <A NAME="DirEntry(com.perforce.api.DirEntry, java.lang.String)"><!-- --></A><H3>
  299. DirEntry</H3>
  300. <PRE>
  301. public <B>DirEntry</B>(<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A>&nbsp;base,
  302.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
  303. <DL>
  304. <DD>Constructs a directory entry.<DD><DL>
  305. <DT><B>Parameters:</B><DD><CODE>base</CODE> - Another <code>DirEntry</code> used to set the environment.<DD><CODE>path</CODE> - The path for this directory.</DL>
  306. </DD>
  307. </DL>
  308. <HR>
  309.  
  310. <A NAME="DirEntry(com.perforce.api.Env)"><!-- --></A><H3>
  311. DirEntry</H3>
  312. <PRE>
  313. public <B>DirEntry</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</PRE>
  314. <DL>
  315. <DD>Constructs a directory entry.<DD><DL>
  316. <DT><B>Parameters:</B><DD><CODE>e</CODE> - Source control environment to use.</DL>
  317. </DD>
  318. </DL>
  319. <HR>
  320.  
  321. <A NAME="DirEntry(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
  322. DirEntry</H3>
  323. <PRE>
  324. public <B>DirEntry</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e,
  325.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
  326. <DL>
  327. <DD>Constructs a directory entry.<DD><DL>
  328. <DT><B>Parameters:</B><DD><CODE>e</CODE> - Source control environment to use.<DD><CODE>path</CODE> - The path for this directory.</DL>
  329. </DD>
  330. </DL>
  331.  
  332. <!-- ============ METHOD DETAIL ========== -->
  333.  
  334. <A NAME="method_detail"><!-- --></A>
  335. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  336. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  337. <TD COLSPAN=1><FONT SIZE="+2">
  338. <B>Method Detail</B></FONT></TD>
  339. </TR>
  340. </TABLE>
  341.  
  342. <A NAME="commit()"><!-- --></A><H3>
  343. commit</H3>
  344. <PRE>
  345. public void <B>commit</B>()</PRE>
  346. <DL>
  347. <DD>Does nothing. Doesn't do anything here, since directories are not really
  348.  stored in perforce.<DD><DL>
  349. <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>
  350. </DD>
  351. </DL>
  352. <HR>
  353.  
  354. <A NAME="getBasePath()"><!-- --></A><H3>
  355. getBasePath</H3>
  356. <PRE>
  357. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getBasePath</B>()</PRE>
  358. <DL>
  359. <DD>Returns the base path for this directory. This includes everything up
  360.  to the last path delimeter.</DL>
  361. <HR>
  362.  
  363. <A NAME="getCache()"><!-- --></A><H3>
  364. getCache</H3>
  365. <PRE>
  366. public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
  367. <DL>
  368. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  369. <DD>Returns the HashDecay instance for this class<DD><DL>
  370. <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>
  371. </DD>
  372. </DL>
  373. <HR>
  374.  
  375. <A NAME="getDirEntry(com.perforce.api.Env, java.lang.String, boolean)"><!-- --></A><H3>
  376. getDirEntry</H3>
  377. <PRE>
  378. public static <A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A> <B>getDirEntry</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
  379.                                    <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path,
  380.                                    boolean&nbsp;sync)</PRE>
  381. <DL>
  382. <DD>Returns a directory entry for the supplied path.<DD><DL>
  383. <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>path</CODE> - The path for this directory.<DD><CODE>sync</CODE> - Forces the directory information to be current.</DL>
  384. </DD>
  385. </DL>
  386. <HR>
  387.  
  388. <A NAME="getDirNames()"><!-- --></A><H3>
  389. getDirNames</H3>
  390. <PRE>
  391. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getDirNames</B>()</PRE>
  392. <DL>
  393. <DD>Returns an array of directory names.</DL>
  394. <HR>
  395.  
  396. <A NAME="getDirNames(com.perforce.api.Env)"><!-- --></A><H3>
  397. getDirNames</H3>
  398. <PRE>
  399. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getDirNames</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  400. <DL>
  401. <DD>Returns an array of directory names.<DD><DL>
  402. <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.</DL>
  403. </DD>
  404. </DL>
  405. <HR>
  406.  
  407. <A NAME="getFileNames()"><!-- --></A><H3>
  408. getFileNames</H3>
  409. <PRE>
  410. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getFileNames</B>()</PRE>
  411. <DL>
  412. <DD>Returns an array of file names for this directory.</DL>
  413. <HR>
  414.  
  415. <A NAME="getFileNames(com.perforce.api.Env)"><!-- --></A><H3>
  416. getFileNames</H3>
  417. <PRE>
  418. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getFileNames</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  419. <DL>
  420. <DD>Returns an array of file names for this directory.<DD><DL>
  421. <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.</DL>
  422. </DD>
  423. </DL>
  424. <HR>
  425.  
  426. <A NAME="getFiles()"><!-- --></A><H3>
  427. getFiles</H3>
  428. <PRE>
  429. public <A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[] <B>getFiles</B>()</PRE>
  430. <DL>
  431. <DD>Returns an array of file entries for this directory.</DL>
  432. <HR>
  433.  
  434. <A NAME="getFiles(com.perforce.api.Env)"><!-- --></A><H3>
  435. getFiles</H3>
  436. <PRE>
  437. public <A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[] <B>getFiles</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
  438. <DL>
  439. <DD>Returns an array of file entries for this directory.<DD><DL>
  440. <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.</DL>
  441. </DD>
  442. </DL>
  443. <HR>
  444.  
  445. <A NAME="getParent()"><!-- --></A><H3>
  446. getParent</H3>
  447. <PRE>
  448. public <A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A> <B>getParent</B>()</PRE>
  449. <DL>
  450. <DD>Returns the parent director. Constructs a new <code>DirEntry</code> that
  451.  represents the parent and returns it.</DL>
  452. <HR>
  453.  
  454. <A NAME="getPath()"><!-- --></A><H3>
  455. getPath</H3>
  456. <PRE>
  457. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getPath</B>()</PRE>
  458. <DL>
  459. <DD>Returns the path for this directory.</DL>
  460. <HR>
  461.  
  462. <A NAME="setPath(java.lang.String)"><!-- --></A><H3>
  463. setPath</H3>
  464. <PRE>
  465. public void <B>setPath</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
  466. <DL>
  467. <DD>Sets the path for this directory.<DD><DL>
  468. <DT><B>Parameters:</B><DD><CODE>path</CODE> - New path for this directory.</DL>
  469. </DD>
  470. </DL>
  471. <HR>
  472.  
  473. <A NAME="sync()"><!-- --></A><H3>
  474. sync</H3>
  475. <PRE>
  476. public void <B>sync</B>()</PRE>
  477. <DL>
  478. <DD>Loads the directories and files for this directory.<DD><DL>
  479. <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>
  480. </DD>
  481. </DL>
  482. <HR>
  483.  
  484. <A NAME="toXML()"><!-- --></A><H3>
  485. toXML</H3>
  486. <PRE>
  487. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  488. <DL>
  489. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  490. <DD>Returns a string containing the object in XML form.<DD><DL>
  491. <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>
  492. </DD>
  493. </DL>
  494. <!-- ========= END OF CLASS DATA ========= -->
  495. <HR>
  496.  
  497. <!-- ========== START OF NAVBAR ========== -->
  498. <A NAME="navbar_bottom"><!-- --></A>
  499. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  500. <TR>
  501. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  502. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  503. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  504.   <TR ALIGN="center" VALIGN="top">
  505.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  506.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  507.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DirEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  508.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  509.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  510.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  511.   </TR>
  512. </TABLE>
  513. </TD>
  514. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  515. <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>
  516. </TD>
  517. </TR>
  518.  
  519. <TR>
  520. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  521. &nbsp;<A HREF="../../../com/perforce/api/Debug.html"><B>PREV CLASS</B></A>&nbsp;
  522. &nbsp;<A HREF="../../../com/perforce/api/Env.html"><B>NEXT CLASS</B></A></FONT></TD>
  523. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  524.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  525. &nbsp;<A HREF="DirEntry.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  526. </TR>
  527. <TR>
  528. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  529.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  530. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  531. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  532. </TR>
  533. </TABLE>
  534. <!-- =========== END OF NAVBAR =========== -->
  535.  
  536. <HR>
  537. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  538. </BODY>
  539. </HTML>
# Change User Description Committed
#1 3616 Nicholas Veeser Branched in the p4package code because I wanted to make some additions and possibly some m...odifications to the object model. « 22 years ago
//public/perforce/api/java/p4package/docs/com/perforce/api/DirEntry.html
#5 2002 David Markley Integrated the latest changes for p4package to the public depot. 23 years ago
#4 1808 David Markley Updated Env class and fixed fstat issues.
Published new Javadocs. 		23 years ago
#3 1361 David Markley Added convenience methods to the Env class. 23 years ago
#2 1334 David Markley Added more example code.
Added the Counter class.
Corrected the filelog methods for the... FileEntry class. «		 23 years ago
#1 1043 David Markley Initial branch to public area. 23 years ago
//guest/david_markley/p4package/docs/com/perforce/api/DirEntry.html
#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