Helix SwarmHelix Swarm
Loading...

Utils.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • Utils.html #8
  • 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  Utils
  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/Utils.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/User.html"><B>PREV CLASS</B></A>&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="Utils.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  Utils</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.Utils</B>
  63. </PRE>
  64. <HR>
  65. <DL>
  66. <DT>public final class <B>Utils</B><DT>extends <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></DL>
  67.  
  68. <P>
  69. Class that contains static utility methods.
  70. <P>
  71. <DL>
  72. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #8 $</DD>
  73. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  74. <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/HashDecay.html"><CODE>HashDecay</CODE></A></DL>
  75. <HR>
  76.  
  77. <P>
  78. <!-- ======== INNER CLASS SUMMARY ======== -->
  79.  
  80.  
  81. <!-- =========== FIELD SUMMARY =========== -->
  82.  
  83.  
  84. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  85.  
  86. <A NAME="constructor_summary"><!-- --></A>
  87. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  88. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  89. <TD COLSPAN=2><FONT SIZE="+2">
  90. <B>Constructor Summary</B></FONT></TD>
  91. </TR>
  92. <TR BGCOLOR="white" CLASS="TableRowColor">
  93. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#Utils()">Utils</A></B>()</CODE>
  94.  
  95. <BR>
  96. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  97. </TR>
  98. </TABLE>
  99. &nbsp;
  100. <!-- ========== METHOD SUMMARY =========== -->
  101.  
  102. <A NAME="method_summary"><!-- --></A>
  103. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  104. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  105. <TD COLSPAN=2><FONT SIZE="+2">
  106. <B>Method Summary</B></FONT></TD>
  107. </TR>
  108. <TR BGCOLOR="white" CLASS="TableRowColor">
  109. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  110. <CODE>static&nbsp;void</CODE></FONT></TD>
  111. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#cleanUp()">cleanUp</A></B>()</CODE>
  112.  
  113. <BR>
  114. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Cleans up after the package has been used.</TD>
  115. </TR>
  116. <TR BGCOLOR="white" CLASS="TableRowColor">
  117. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  118. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  119. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#commonPrefix(java.util.Enumeration)">commonPrefix</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A>&nbsp;en)</CODE>
  120.  
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns common prefix for an Enumeration of strings.</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  126. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  127. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#commonPrefix(java.util.Vector)">commonPrefix</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A>&nbsp;v)</CODE>
  128.  
  129. <BR>
  130. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns common prefix for a Vector of strings.</TD>
  131. </TR>
  132. <TR BGCOLOR="white" CLASS="TableRowColor">
  133. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  134. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/StringBuffer.html">StringBuffer</A></CODE></FONT></TD>
  135. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#formatDepotPath(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)">formatDepotPath</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path,
  136.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;pathfmt,
  137.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;filefmt,
  138.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;revfmt,
  139.                 boolean&nbsp;urlencode)</CODE>
  140.  
  141. <BR>
  142. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Breaks up a depot path and formats each level.</TD>
  143. </TR>
  144. <TR BGCOLOR="white" CLASS="TableRowColor">
  145. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  146. <CODE>static&nbsp;int</CODE></FONT></TD>
  147. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#getChangeFromPath(java.lang.String)">getChangeFromPath</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
  148.  
  149. <BR>
  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the change number portion of a depot path, if there is
  151.  a valid one found.</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#getEnumeration(java.util.Iterator)">getEnumeration</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A>&nbsp;i)</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>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  164. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#HTMLEncode(java.lang.String)">HTMLEncode</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;str)</CODE>
  165.  
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the string encoded for HTML use.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>static&nbsp;void</CODE></FONT></TD>
  172. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#initPackage()">initPackage</A></B>()</CODE>
  173.  
  174. <BR>
  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the package, in order to avoid some arbitrary JVM problems
  176.  that have been encountered.</TD>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>static&nbsp;boolean</CODE></FONT></TD>
  181. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#isMSJVM()">isMSJVM</A></B>()</CODE>
  182.  
  183. <BR>
  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check to see if the current Java Virtual Machine is made by Microsoft</TD>
  185. </TR>
  186. <TR BGCOLOR="white" CLASS="TableRowColor">
  187. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  188. <CODE>static&nbsp;boolean</CODE></FONT></TD>
  189. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#isWindows()">isWindows</A></B>()</CODE>
  190.  
  191. <BR>
  192. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check to see if the current operating system is a Windows OS</TD>
  193. </TR>
  194. <TR BGCOLOR="white" CLASS="TableRowColor">
  195. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  196. <CODE>static&nbsp;boolean</CODE></FONT></TD>
  197. <TD><CODE><B><A HREF="../../../com/perforce/api/Utils.html#wildPathMatch(java.lang.String, java.lang.String)">wildPathMatch</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;wildpath,
  198.               <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
  199.  
  200. <BR>
  201. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the <code>path</code> matches the <code>wildpath</code>.</TD>
  202. </TR>
  203. </TABLE>
  204. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  205. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  206. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  207. <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>
  208. </TR>
  209. <TR BGCOLOR="white" CLASS="TableRowColor">
  210. <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>
  211. </TR>
  212. </TABLE>
  213. &nbsp;
  214. <P>
  215.  
  216. <!-- ============ FIELD DETAIL =========== -->
  217.  
  218.  
  219. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  220.  
  221. <A NAME="constructor_detail"><!-- --></A>
  222. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  223. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  224. <TD COLSPAN=1><FONT SIZE="+2">
  225. <B>Constructor Detail</B></FONT></TD>
  226. </TR>
  227. </TABLE>
  228.  
  229. <A NAME="Utils()"><!-- --></A><H3>
  230. Utils</H3>
  231. <PRE>
  232. public <B>Utils</B>()</PRE>
  233. <DL>
  234. </DL>
  235.  
  236. <!-- ============ METHOD DETAIL ========== -->
  237.  
  238. <A NAME="method_detail"><!-- --></A>
  239. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  240. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  241. <TD COLSPAN=1><FONT SIZE="+2">
  242. <B>Method Detail</B></FONT></TD>
  243. </TR>
  244. </TABLE>
  245.  
  246. <A NAME="cleanUp()"><!-- --></A><H3>
  247. cleanUp</H3>
  248. <PRE>
  249. public static void <B>cleanUp</B>()</PRE>
  250. <DL>
  251. <DD>Cleans up after the package has been used. This stops any running threads
  252.  and releases any objects for garbage collection.</DL>
  253. <HR>
  254.  
  255. <A NAME="commonPrefix(java.util.Enumeration)"><!-- --></A><H3>
  256. commonPrefix</H3>
  257. <PRE>
  258. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>commonPrefix</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A>&nbsp;en)</PRE>
  259. <DL>
  260. <DD>Returns common prefix for an Enumeration of strings.</DL>
  261. <HR>
  262.  
  263. <A NAME="commonPrefix(java.util.Vector)"><!-- --></A><H3>
  264. commonPrefix</H3>
  265. <PRE>
  266. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>commonPrefix</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A>&nbsp;v)</PRE>
  267. <DL>
  268. <DD>Returns common prefix for a Vector of strings. This is very useful for
  269.  determining a commong prefix for a set of paths.</DL>
  270. <HR>
  271.  
  272. <A NAME="formatDepotPath(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
  273. formatDepotPath</H3>
  274. <PRE>
  275. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/StringBuffer.html">StringBuffer</A> <B>formatDepotPath</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path,
  276.                                            <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;pathfmt,
  277.                                            <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;filefmt,
  278.                                            <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;revfmt,
  279.                                            boolean&nbsp;urlencode)
  280.                                     throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  281. <DL>
  282. <DD>Breaks up a depot path and formats each level. Each format string takes
  283.  two arguments. The first is set to the full path to a particular
  284.  element. The second is set to the short name for the element.
  285.  <p>
  286.  This is extremely useful for setting up links from each component of a
  287.  path.<DD><DL>
  288. <DT><B>Parameters:</B><DD><CODE>path</CODE> - The path to be formatted.<DD><CODE>pathfmt</CODE> - The format to be used for path elements.<DD><CODE>filefmt</CODE> - The format to be used for the file element.<DD><CODE>revfmt</CODE> - The format to be used for the rev component.<DD><CODE>urlencode</CODE> - Determines if paths are encoded.<DT><B>See Also: </B><DD><CODE>URLEncoder</CODE></DL>
  289. </DD>
  290. </DL>
  291. <HR>
  292.  
  293. <A NAME="getChangeFromPath(java.lang.String)"><!-- --></A><H3>
  294. getChangeFromPath</H3>
  295. <PRE>
  296. public static final int <B>getChangeFromPath</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
  297. <DL>
  298. <DD>Returns the change number portion of a depot path, if there is
  299.  a valid one found. Otherwise, it returns -1.</DL>
  300. <HR>
  301.  
  302. <A NAME="getEnumeration(java.util.Iterator)"><!-- --></A><H3>
  303. getEnumeration</H3>
  304. <PRE>
  305. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>getEnumeration</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A>&nbsp;i)</PRE>
  306. <DL>
  307. </DL>
  308. <HR>
  309.  
  310. <A NAME="HTMLEncode(java.lang.String)"><!-- --></A><H3>
  311. HTMLEncode</H3>
  312. <PRE>
  313. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>HTMLEncode</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;str)</PRE>
  314. <DL>
  315. <DD>Returns the string encoded for HTML use.<p>
  316.  > becomes &gt; and < becomes &lt;</DL>
  317. <HR>
  318.  
  319. <A NAME="initPackage()"><!-- --></A><H3>
  320. initPackage</H3>
  321. <PRE>
  322. public static void <B>initPackage</B>()</PRE>
  323. <DL>
  324. <DD>Initializes the package, in order to avoid some arbitrary JVM problems
  325.  that have been encountered. This is a hack and should not have to be done
  326.  if certain overbearing empires starting with the letter M built a fully
  327.  compliant JVM.</DL>
  328. <HR>
  329.  
  330. <A NAME="isMSJVM()"><!-- --></A><H3>
  331. isMSJVM</H3>
  332. <PRE>
  333. public static boolean <B>isMSJVM</B>()</PRE>
  334. <DL>
  335. <DD>Check to see if the current Java Virtual Machine is made by Microsoft<DD><DL>
  336. <DT><B>Returns:</B><DD>boolean true if the java.vendor property comtains the word 'Microsoft'</DL>
  337. </DD>
  338. </DL>
  339. <HR>
  340.  
  341. <A NAME="isWindows()"><!-- --></A><H3>
  342. isWindows</H3>
  343. <PRE>
  344. public static boolean <B>isWindows</B>()</PRE>
  345. <DL>
  346. <DD>Check to see if the current operating system is a Windows OS<DD><DL>
  347. <DT><B>Returns:</B><DD>boolean true if the os.name property comtains the word 'Windows'</DL>
  348. </DD>
  349. </DL>
  350. <HR>
  351.  
  352. <A NAME="wildPathMatch(java.lang.String, java.lang.String)"><!-- --></A><H3>
  353. wildPathMatch</H3>
  354. <PRE>
  355. public static boolean <B>wildPathMatch</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;wildpath,
  356.                                     <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
  357. <DL>
  358. <DD>Returns true if the <code>path</code> matches the <code>wildpath</code>.
  359.  Only perforce wildcards are considered in the <code>wildpath</code>.</DL>
  360. <!-- ========= END OF CLASS DATA ========= -->
  361. <HR>
  362.  
  363. <!-- ========== START OF NAVBAR ========== -->
  364. <A NAME="navbar_bottom"><!-- --></A>
  365. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  366. <TR>
  367. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  368. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  369. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  370.   <TR ALIGN="center" VALIGN="top">
  371.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  372.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  373.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Utils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  374.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  375.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  376.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  377.   </TR>
  378. </TABLE>
  379. </TD>
  380. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  381. <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>
  382. </TD>
  383. </TR>
  384.  
  385. <TR>
  386. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  387. &nbsp;<A HREF="../../../com/perforce/api/User.html"><B>PREV CLASS</B></A>&nbsp;
  388. &nbsp;NEXT CLASS</FONT></TD>
  389. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  390.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  391. &nbsp;<A HREF="Utils.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  392. </TR>
  393. <TR>
  394. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  395.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  396. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  397. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  398. </TR>
  399. </TABLE>
  400. <!-- =========== END OF NAVBAR =========== -->
  401.  
  402. <HR>
  403. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  404. </BODY>
  405. </HTML>
# Change User Description Committed
#8 2001 David Markley Updated package documentation. 23 years ago
#7 1887 David Markley Updated the class docs. 23 years ago
#6 1387 David Markley Added the ability to reopen files, add them to changelists, and updated the
documentation... to reflect these changes. «		 23 years ago
#5 1360 David Markley Updated Env class. 23 years ago
#4 1332 David Markley Added more example code.
Added the Counter class.
Corrected the filelog methods for the... FileEntry class. «		 23 years ago
#3 1147 David Markley Added the ability to clean up threads after the package has been used. 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