Loading...
Helix SwarmHelix Swarm
Loading...

package-use.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • package-use.html #6
  • View
  • Commits
  • Open Download .zip Download (10 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:00 EDT 2002 -->
  6. <TITLE>
  7. Perforce API: Uses of Package com.perforce.api
  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="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  23.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT>&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&nbsp;
  38. &nbsp;NEXT</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="package-use.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  42. </TR>
  43. </TABLE>
  44. <!-- =========== END OF NAVBAR =========== -->
  45.  
  46. <HR>
  47. <CENTER>
  48. <H2>
  49. <B>Uses of Package<br>com.perforce.api</B></H2>
  50. </CENTER>
  51. <A NAME="com.perforce.api"><!-- --></A>
  52. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  53. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  54. <TD COLSPAN=2><FONT SIZE="+2">
  55. Classes in <A HREF="../../../com/perforce/api/package-summary.html">com.perforce.api</A> used by <A HREF="../../../com/perforce/api/package-summary.html">com.perforce.api</A><TR BGCOLOR="white" CLASS="TableRowColor">
  56. <TD><B><A HREF="../../../com/perforce/api/class-use/Branch.html#com.perforce.api"><B>Branch</B></A></B>
  57.  
  58. <BR>
  59. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control branch.</TD>
  60. </TR>
  61. <TR BGCOLOR="white" CLASS="TableRowColor">
  62. <TD><B><A HREF="../../../com/perforce/api/class-use/Cacheable.html#com.perforce.api"><B>Cacheable</B></A></B>
  63.  
  64. <BR>
  65. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An interface that indicates the implementing class can be cached for some
  66.  period of time.</TD>
  67. </TR>
  68. <TR BGCOLOR="white" CLASS="TableRowColor">
  69. <TD><B><A HREF="../../../com/perforce/api/class-use/Change.html#com.perforce.api"><B>Change</B></A></B>
  70.  
  71. <BR>
  72. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control change.</TD>
  73. </TR>
  74. <TR BGCOLOR="white" CLASS="TableRowColor">
  75. <TD><B><A HREF="../../../com/perforce/api/class-use/Client.html#com.perforce.api"><B>Client</B></A></B>
  76.  
  77. <BR>
  78. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control client.</TD>
  79. </TR>
  80. <TR BGCOLOR="white" CLASS="TableRowColor">
  81. <TD><B><A HREF="../../../com/perforce/api/class-use/CommitException.html#com.perforce.api"><B>CommitException</B></A></B>
  82.  
  83. <BR>
  84. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that an exception occurred during the process of committing a
  85.  cacheable object to perforce.</TD>
  86. </TR>
  87. <TR BGCOLOR="white" CLASS="TableRowColor">
  88. <TD><B><A HREF="../../../com/perforce/api/class-use/Counter.html#com.perforce.api"><B>Counter</B></A></B>
  89.  
  90. <BR>
  91. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of perforce counters.</TD>
  92. </TR>
  93. <TR BGCOLOR="white" CLASS="TableRowColor">
  94. <TD><B><A HREF="../../../com/perforce/api/class-use/DirEntry.html#com.perforce.api"><B>DirEntry</B></A></B>
  95.  
  96. <BR>
  97. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control directory.</TD>
  98. </TR>
  99. <TR BGCOLOR="white" CLASS="TableRowColor">
  100. <TD><B><A HREF="../../../com/perforce/api/class-use/Env.html#com.perforce.api"><B>Env</B></A></B>
  101.  
  102. <BR>
  103. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control environment.</TD>
  104. </TR>
  105. <TR BGCOLOR="white" CLASS="TableRowColor">
  106. <TD><B><A HREF="../../../com/perforce/api/class-use/EventLog.html#com.perforce.api"><B>EventLog</B></A></B>
  107.  
  108. <BR>
  109. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This class controls an event log.</TD>
  110. </TR>
  111. <TR BGCOLOR="white" CLASS="TableRowColor">
  112. <TD><B><A HREF="../../../com/perforce/api/class-use/FileEntry.html#com.perforce.api"><B>FileEntry</B></A></B>
  113.  
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control file.</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD><B><A HREF="../../../com/perforce/api/class-use/HashDecay.html#com.perforce.api"><B>HashDecay</B></A></B>
  119.  
  120. <BR>
  121. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This hashtable build to contain objects that will decay over time.</TD>
  122. </TR>
  123. <TR BGCOLOR="white" CLASS="TableRowColor">
  124. <TD><B><A HREF="../../../com/perforce/api/class-use/Job.html#com.perforce.api"><B>Job</B></A></B>
  125.  
  126. <BR>
  127. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control job.</TD>
  128. </TR>
  129. <TR BGCOLOR="white" CLASS="TableRowColor">
  130. <TD><B><A HREF="../../../com/perforce/api/class-use/JobField.html#com.perforce.api"><B>JobField</B></A></B>
  131.  
  132. <BR>
  133. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Data class for p4 jobspec field information.</TD>
  134. </TR>
  135. <TR BGCOLOR="white" CLASS="TableRowColor">
  136. <TD><B><A HREF="../../../com/perforce/api/class-use/Label.html#com.perforce.api"><B>Label</B></A></B>
  137.  
  138. <BR>
  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control lablel.</TD>
  140. </TR>
  141. <TR BGCOLOR="white" CLASS="TableRowColor">
  142. <TD><B><A HREF="../../../com/perforce/api/class-use/Mapping.html#com.perforce.api"><B>Mapping</B></A></B>
  143.  
  144. <BR>
  145. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control mapping.</TD>
  146. </TR>
  147. <TR BGCOLOR="white" CLASS="TableRowColor">
  148. <TD><B><A HREF="../../../com/perforce/api/class-use/P4Process.html#com.perforce.api"><B>P4Process</B></A></B>
  149.  
  150. <BR>
  151. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles the execution of all perforce commands.</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD><B><A HREF="../../../com/perforce/api/class-use/PerforceException.html#com.perforce.api"><B>PerforceException</B></A></B>
  155.  
  156. <BR>
  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that a general exception occurred when working with Perforce.</TD>
  158. </TR>
  159. <TR BGCOLOR="white" CLASS="TableRowColor">
  160. <TD><B><A HREF="../../../com/perforce/api/class-use/SourceControlObject.html#com.perforce.api"><B>SourceControlObject</B></A></B>
  161.  
  162. <BR>
  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An abstract base class for all source control objects.</TD>
  164. </TR>
  165. <TR BGCOLOR="white" CLASS="TableRowColor">
  166. <TD><B><A HREF="../../../com/perforce/api/class-use/SubmitException.html#com.perforce.api"><B>SubmitException</B></A></B>
  167.  
  168. <BR>
  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that an exception occurred during a submit to Perforce.</TD>
  170. </TR>
  171. <TR BGCOLOR="white" CLASS="TableRowColor">
  172. <TD><B><A HREF="../../../com/perforce/api/class-use/User.html#com.perforce.api"><B>User</B></A></B>
  173.  
  174. <BR>
  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Representation of a source control user.</TD>
  176. </TR>
  177. </FONT></TD>
  178. </TR>
  179. </TABLE>
  180. &nbsp;
  181. <P>
  182. <HR>
  183.  
  184. <!-- ========== START OF NAVBAR ========== -->
  185. <A NAME="navbar_bottom"><!-- --></A>
  186. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  187. <TR>
  188. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  189. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  190. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  191.   <TR ALIGN="center" VALIGN="top">
  192.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  193.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  194.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT>&nbsp;</TD>
  195.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  196.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  197.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  198.   </TR>
  199. </TABLE>
  200. </TD>
  201. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  202. <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>
  203. </TD>
  204. </TR>
  205.  
  206. <TR>
  207. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  208. &nbsp;PREV&nbsp;
  209. &nbsp;NEXT</FONT></TD>
  210. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  211.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  212. &nbsp;<A HREF="package-use.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  213. </TR>
  214. </TABLE>
  215. <!-- =========== END OF NAVBAR =========== -->
  216.  
  217. <HR>
  218. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  219. </BODY>
  220. </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