Helix SwarmHelix Swarm
Loading...

P4Process.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • P4Process.html #7
  • View
  • Commits
  • Open Download .zip Download (26 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  P4Process
  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/P4Process.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/P4JNI.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="P4Process.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  P4Process</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.P4Process</B>
  63. </PRE>
  64. <HR>
  65. <DL>
  66. <DT>public class <B>P4Process</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. Handles the execution of all perforce commands. This class can be used
  70.  directly, but the preferred use of this API is through the
  71.  <A HREF="../../../com/perforce/api/SourceControlObject.html"><CODE>SourceControlObject</CODE></A> subclasses.
  72.  <p>
  73.  <b>Example Usage:</b>
  74.  <pre>
  75.   String l;
  76.   Env env = new Env();
  77.   String[] cmd = { "p4", "branches"};
  78.   try {
  79.     P4Process p = new P4Process(env);
  80.     p.exec(cmd);
  81.     while (null != (l = p.readLine())) {
  82.       // Parse the output.
  83.     }
  84.     p.close();
  85.   } catch (Exception ex) {
  86.     throw new PerforceException(ex.getMessage());
  87.   }
  88.  </pre>
  89. <P>
  90. <DL>
  91. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #7 $</DD>
  92. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  93. <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Env.html"><CODE>Env</CODE></A>, 
  94. <A HREF="../../../com/perforce/api/SourceControlObject.html"><CODE>SourceControlObject</CODE></A>, 
  95. <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Thread.html"><CODE>Thread</CODE></A></DL>
  96. <HR>
  97.  
  98. <P>
  99. <!-- ======== INNER CLASS SUMMARY ======== -->
  100.  
  101.  
  102. <!-- =========== FIELD SUMMARY =========== -->
  103.  
  104.  
  105. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  106.  
  107. <A NAME="constructor_summary"><!-- --></A>
  108. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  109. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  110. <TD COLSPAN=2><FONT SIZE="+2">
  111. <B>Constructor Summary</B></FONT></TD>
  112. </TR>
  113. <TR BGCOLOR="white" CLASS="TableRowColor">
  114. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#P4Process()">P4Process</A></B>()</CODE>
  115.  
  116. <BR>
  117. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default no-argument constructor.</TD>
  118. </TR>
  119. <TR BGCOLOR="white" CLASS="TableRowColor">
  120. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#P4Process(com.perforce.api.Env)">P4Process</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</CODE>
  121.  
  122. <BR>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that specifies the source control environment.</TD>
  124. </TR>
  125. </TABLE>
  126. &nbsp;
  127. <!-- ========== METHOD SUMMARY =========== -->
  128.  
  129. <A NAME="method_summary"><!-- --></A>
  130. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  131. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  132. <TD COLSPAN=2><FONT SIZE="+2">
  133. <B>Method Summary</B></FONT></TD>
  134. </TR>
  135. <TR BGCOLOR="white" CLASS="TableRowColor">
  136. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  137. <CODE>&nbsp;int</CODE></FONT></TD>
  138. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#close()">close</A></B>()</CODE>
  139.  
  140. <BR>
  141. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Waits for the underlying process to exit and closes it down.</TD>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  145. <CODE>&nbsp;int</CODE></FONT></TD>
  146. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#close(java.io.PrintStream)">close</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/PrintStream.html">PrintStream</A>&nbsp;out)</CODE>
  147.  
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Waits for the process to exit and closes out the process.</TD>
  150. </TR>
  151. <TR BGCOLOR="white" CLASS="TableRowColor">
  152. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  153. <CODE>&nbsp;void</CODE></FONT></TD>
  154. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#exec(java.lang.String[])">exec</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]&nbsp;cmd)</CODE>
  155.  
  156. <BR>
  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes a p4 command.</TD>
  158. </TR>
  159. <TR BGCOLOR="white" CLASS="TableRowColor">
  160. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  161. <CODE>&nbsp;void</CODE></FONT></TD>
  162. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#flush()">flush</A></B>()</CODE>
  163.  
  164. <BR>
  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flushes the output stream to the process.</TD>
  166. </TR>
  167. <TR BGCOLOR="white" CLASS="TableRowColor">
  168. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  169. <CODE>static&nbsp;<A HREF="../../../com/perforce/api/P4Process.html">P4Process</A></CODE></FONT></TD>
  170. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#getBase()">getBase</A></B>()</CODE>
  171.  
  172. <BR>
  173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the base process for this class.</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="../../../com/perforce/api/Env.html">Env</A></CODE></FONT></TD>
  178. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#getEnv()">getEnv</A></B>()</CODE>
  179.  
  180. <BR>
  181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the environment in use by this process.</TD>
  182. </TR>
  183. <TR BGCOLOR="white" CLASS="TableRowColor">
  184. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  185. <CODE>&nbsp;int</CODE></FONT></TD>
  186. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#getExitCode()">getExitCode</A></B>()</CODE>
  187.  
  188. <BR>
  189. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the exit code returned when the underlying process exits.</TD>
  190. </TR>
  191. <TR BGCOLOR="white" CLASS="TableRowColor">
  192. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  193. <CODE>&nbsp;boolean</CODE></FONT></TD>
  194. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#getRawMode()">getRawMode</A></B>()</CODE>
  195.  
  196. <BR>
  197. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the status of raw mode for this process.</TD>
  198. </TR>
  199. <TR BGCOLOR="white" CLASS="TableRowColor">
  200. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  201. <CODE>&nbsp;long</CODE></FONT></TD>
  202. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#getServerTimeout()">getServerTimeout</A></B>()</CODE>
  203.  
  204. <BR>
  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the server timeout threshold.</TD>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  209. <CODE>&nbsp;void</CODE></FONT></TD>
  210. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#outClose()">outClose</A></B>()</CODE>
  211.  
  212. <BR>
  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flushes and closes the output stream to the process.</TD>
  214. </TR>
  215. <TR BGCOLOR="white" CLASS="TableRowColor">
  216. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  217. <CODE>&nbsp;void</CODE></FONT></TD>
  218. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#print(java.lang.String)">print</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;line)</CODE>
  219.  
  220. <BR>
  221. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes <code>line</code> to the standard input of the process.</TD>
  222. </TR>
  223. <TR BGCOLOR="white" CLASS="TableRowColor">
  224. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  225. <CODE>&nbsp;void</CODE></FONT></TD>
  226. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#println(java.lang.String)">println</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;line)</CODE>
  227.  
  228. <BR>
  229. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes <code>line</code> to the standard input of the process.</TD>
  230. </TR>
  231. <TR BGCOLOR="white" CLASS="TableRowColor">
  232. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  233. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  234. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#readLine()">readLine</A></B>()</CODE>
  235.  
  236. <BR>
  237. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next line from the process, or null if the command has
  238.  completed its execution.</TD>
  239. </TR>
  240. <TR BGCOLOR="white" CLASS="TableRowColor">
  241. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  242. <CODE>static&nbsp;void</CODE></FONT></TD>
  243. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#setBase(com.perforce.api.P4Process)">setBase</A></B>(<A HREF="../../../com/perforce/api/P4Process.html">P4Process</A>&nbsp;b)</CODE>
  244.  
  245. <BR>
  246. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the base process to be used when new processes are instantiated.</TD>
  247. </TR>
  248. <TR BGCOLOR="white" CLASS="TableRowColor">
  249. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  250. <CODE>&nbsp;void</CODE></FONT></TD>
  251. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#setEnv(com.perforce.api.Env)">setEnv</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</CODE>
  252.  
  253. <BR>
  254. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the environment to use.</TD>
  255. </TR>
  256. <TR BGCOLOR="white" CLASS="TableRowColor">
  257. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  258. <CODE>&nbsp;void</CODE></FONT></TD>
  259. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#setEventLog(com.perforce.api.EventLog)">setEventLog</A></B>(<A HREF="../../../com/perforce/api/EventLog.html">EventLog</A>&nbsp;log)</CODE>
  260.  
  261. <BR>
  262. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the event log.</TD>
  263. </TR>
  264. <TR BGCOLOR="white" CLASS="TableRowColor">
  265. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  266. <CODE>&nbsp;void</CODE></FONT></TD>
  267. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#setRawMode(boolean)">setRawMode</A></B>(boolean&nbsp;raw)</CODE>
  268.  
  269. <BR>
  270. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In raw mode, the process will return the prefix added by the "-s" command
  271.  line option.</TD>
  272. </TR>
  273. <TR BGCOLOR="white" CLASS="TableRowColor">
  274. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  275. <CODE>&nbsp;void</CODE></FONT></TD>
  276. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#setServerTimeout(long)">setServerTimeout</A></B>(long&nbsp;threshold)</CODE>
  277.  
  278. <BR>
  279. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the server timeout threshold.</TD>
  280. </TR>
  281. <TR BGCOLOR="white" CLASS="TableRowColor">
  282. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  283. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  284. <TD><CODE><B><A HREF="../../../com/perforce/api/P4Process.html#toString()">toString</A></B>()</CODE>
  285.  
  286. <BR>
  287. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  288. </TR>
  289. </TABLE>
  290. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  291. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  292. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  293. <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>
  294. </TR>
  295. <TR BGCOLOR="white" CLASS="TableRowColor">
  296. <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#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>
  297. </TR>
  298. </TABLE>
  299. &nbsp;
  300. <P>
  301.  
  302. <!-- ============ FIELD DETAIL =========== -->
  303.  
  304.  
  305. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  306.  
  307. <A NAME="constructor_detail"><!-- --></A>
  308. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  309. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  310. <TD COLSPAN=1><FONT SIZE="+2">
  311. <B>Constructor Detail</B></FONT></TD>
  312. </TR>
  313. </TABLE>
  314.  
  315. <A NAME="P4Process()"><!-- --></A><H3>
  316. P4Process</H3>
  317. <PRE>
  318. public <B>P4Process</B>()</PRE>
  319. <DL>
  320. <DD>Default no-argument constructor. If the runtime has not been established,
  321.  this constructor will set it up. No environment is specified, so the base
  322.  environment will be used if it exists.<DD><DL>
  323. <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/P4Process.html#getBase()"><CODE>getBase()</CODE></A></DL>
  324. </DD>
  325. </DL>
  326. <HR>
  327.  
  328. <A NAME="P4Process(com.perforce.api.Env)"><!-- --></A><H3>
  329. P4Process</H3>
  330. <PRE>
  331. public <B>P4Process</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</PRE>
  332. <DL>
  333. <DD>Constructor that specifies the source control environment.<DD><DL>
  334. <DT><B>Parameters:</B><DD><CODE>e</CODE> - Source control environment to use.</DL>
  335. </DD>
  336. </DL>
  337.  
  338. <!-- ============ METHOD DETAIL ========== -->
  339.  
  340. <A NAME="method_detail"><!-- --></A>
  341. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  342. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  343. <TD COLSPAN=1><FONT SIZE="+2">
  344. <B>Method Detail</B></FONT></TD>
  345. </TR>
  346. </TABLE>
  347.  
  348. <A NAME="close()"><!-- --></A><H3>
  349. close</H3>
  350. <PRE>
  351. public int <B>close</B>()
  352.           throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  353. <DL>
  354. <DD>Waits for the underlying process to exit and closes it down. This method
  355.  should be called after the <A HREF="../../../com/perforce/api/P4Process.html#exec(java.lang.String[])"><CODE>exec</CODE></A>
  356.  method in order to close things out properly. Errors are sent to 
  357.  System.err.<DD><DL>
  358. <DT><B>Returns:</B><DD>The exit value of the underlying process.<DT><B>See Also: </B><DD><CODE>System</CODE></DL>
  359. </DD>
  360. </DL>
  361. <HR>
  362.  
  363. <A NAME="close(java.io.PrintStream)"><!-- --></A><H3>
  364. close</H3>
  365. <PRE>
  366. public int <B>close</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/PrintStream.html">PrintStream</A>&nbsp;out)
  367.           throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  368. <DL>
  369. <DD>Waits for the process to exit and closes out the process. This method
  370.  should be called after the <A HREF="../../../com/perforce/api/P4Process.html#exec(java.lang.String[])"><CODE>exec</CODE></A>
  371.  method in order to close things down properly.<DD><DL>
  372. <DT><B>Parameters:</B><DD><CODE>out</CODE> - The stream to which any errors should be sent.<DT><B>Returns:</B><DD>The exit value of the underlying process.</DL>
  373. </DD>
  374. </DL>
  375. <HR>
  376.  
  377. <A NAME="exec(java.lang.String[])"><!-- --></A><H3>
  378. exec</H3>
  379. <PRE>
  380. public void <B>exec</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]&nbsp;cmd)
  381.           throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  382. <DL>
  383. <DD>Executes a p4 command. This uses the class environment information
  384.  to execute the p4 command specified in the String array. This array
  385.  contains all the command line arguments that will be specified for
  386.  execution, including "p4" in the first position.<DD><DL>
  387. <DT><B>Parameters:</B><DD><CODE>cmd</CODE> - Array of command line arguments ("p4" must be first).</DL>
  388. </DD>
  389. </DL>
  390. <HR>
  391.  
  392. <A NAME="flush()"><!-- --></A><H3>
  393. flush</H3>
  394. <PRE>
  395. public void <B>flush</B>()
  396.            throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  397. <DL>
  398. <DD>Flushes the output stream to the process.</DL>
  399. <HR>
  400.  
  401. <A NAME="getBase()"><!-- --></A><H3>
  402. getBase</H3>
  403. <PRE>
  404. public static <A HREF="../../../com/perforce/api/P4Process.html">P4Process</A> <B>getBase</B>()</PRE>
  405. <DL>
  406. <DD>Returns the base process for this class. The base process is set when
  407.  this class is first instantiated. The base process is used when other
  408.  <code>P4Process</code> are instantiated to share settings, including the
  409.  <A HREF="../../../com/perforce/api/Env.html"><CODE>source control environment</CODE></A>.<DD><DL>
  410. <DT><B>Returns:</B><DD>Source control environment.<DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Env.html"><CODE>Env</CODE></A></DL>
  411. </DD>
  412. </DL>
  413. <HR>
  414.  
  415. <A NAME="getEnv()"><!-- --></A><H3>
  416. getEnv</H3>
  417. <PRE>
  418. public <A HREF="../../../com/perforce/api/Env.html">Env</A> <B>getEnv</B>()</PRE>
  419. <DL>
  420. <DD>Returns the environment in use by this process.<DD><DL>
  421. <DT><B>Returns:</B><DD>Source control environment.</DL>
  422. </DD>
  423. </DL>
  424. <HR>
  425.  
  426. <A NAME="getExitCode()"><!-- --></A><H3>
  427. getExitCode</H3>
  428. <PRE>
  429. public int <B>getExitCode</B>()</PRE>
  430. <DL>
  431. <DD>Returns the exit code returned when the underlying process exits.<DD><DL>
  432. <DT><B>Returns:</B><DD>Typical UNIX style return code.</DL>
  433. </DD>
  434. </DL>
  435. <HR>
  436.  
  437. <A NAME="getRawMode()"><!-- --></A><H3>
  438. getRawMode</H3>
  439. <PRE>
  440. public boolean <B>getRawMode</B>()</PRE>
  441. <DL>
  442. <DD>Returns the status of raw mode for this process.</DL>
  443. <HR>
  444.  
  445. <A NAME="getServerTimeout()"><!-- --></A><H3>
  446. getServerTimeout</H3>
  447. <PRE>
  448. public long <B>getServerTimeout</B>()</PRE>
  449. <DL>
  450. <DD>Return the server timeout threshold.</DL>
  451. <HR>
  452.  
  453. <A NAME="outClose()"><!-- --></A><H3>
  454. outClose</H3>
  455. <PRE>
  456. public void <B>outClose</B>()
  457.               throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  458. <DL>
  459. <DD>Flushes and closes the output stream to the process.</DL>
  460. <HR>
  461.  
  462. <A NAME="print(java.lang.String)"><!-- --></A><H3>
  463. print</H3>
  464. <PRE>
  465. public void <B>print</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;line)
  466.            throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  467. <DL>
  468. <DD>Writes <code>line</code> to the standard input of the process.<DD><DL>
  469. <DT><B>Parameters:</B><DD><CODE>line</CODE> - Line to be written.</DL>
  470. </DD>
  471. </DL>
  472. <HR>
  473.  
  474. <A NAME="println(java.lang.String)"><!-- --></A><H3>
  475. println</H3>
  476. <PRE>
  477. public void <B>println</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;line)
  478.              throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
  479. <DL>
  480. <DD>Writes <code>line</code> to the standard input of the process. A
  481.  newline is appended to the output.<DD><DL>
  482. <DT><B>Parameters:</B><DD><CODE>line</CODE> - Line to be written.</DL>
  483. </DD>
  484. </DL>
  485. <HR>
  486.  
  487. <A NAME="readLine()"><!-- --></A><H3>
  488. readLine</H3>
  489. <PRE>
  490. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>readLine</B>()</PRE>
  491. <DL>
  492. <DD>Returns the next line from the process, or null if the command has
  493.  completed its execution.</DL>
  494. <HR>
  495.  
  496. <A NAME="setBase(com.perforce.api.P4Process)"><!-- --></A><H3>
  497. setBase</H3>
  498. <PRE>
  499. public static void <B>setBase</B>(<A HREF="../../../com/perforce/api/P4Process.html">P4Process</A>&nbsp;b)</PRE>
  500. <DL>
  501. <DD>Sets the base process to be used when new processes are instantiated.<DD><DL>
  502. <DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/P4Process.html#getBase()"><CODE>getBase()</CODE></A></DL>
  503. </DD>
  504. </DL>
  505. <HR>
  506.  
  507. <A NAME="setEnv(com.perforce.api.Env)"><!-- --></A><H3>
  508. setEnv</H3>
  509. <PRE>
  510. public void <B>setEnv</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</PRE>
  511. <DL>
  512. <DD>Sets the environment to use.<DD><DL>
  513. <DT><B>Parameters:</B><DD><CODE>e</CODE> - Source control environment.</DL>
  514. </DD>
  515. </DL>
  516. <HR>
  517.  
  518. <A NAME="setEventLog(com.perforce.api.EventLog)"><!-- --></A><H3>
  519. setEventLog</H3>
  520. <PRE>
  521. public void <B>setEventLog</B>(<A HREF="../../../com/perforce/api/EventLog.html">EventLog</A>&nbsp;log)</PRE>
  522. <DL>
  523. <DD>Sets the event log. Any events that should be logged will be logged
  524.  through the EventLog specified here.<DD><DL>
  525. <DT><B>Parameters:</B><DD><CODE>log</CODE> - Log for all events.</DL>
  526. </DD>
  527. </DL>
  528. <HR>
  529.  
  530. <A NAME="setRawMode(boolean)"><!-- --></A><H3>
  531. setRawMode</H3>
  532. <PRE>
  533. public void <B>setRawMode</B>(boolean&nbsp;raw)</PRE>
  534. <DL>
  535. <DD>In raw mode, the process will return the prefix added by the "-s" command
  536.  line option. The default is false.</DL>
  537. <HR>
  538.  
  539. <A NAME="setServerTimeout(long)"><!-- --></A><H3>
  540. setServerTimeout</H3>
  541. <PRE>
  542. public void <B>setServerTimeout</B>(long&nbsp;threshold)</PRE>
  543. <DL>
  544. <DD>Set the server timeout threshold.</DL>
  545. <HR>
  546.  
  547. <A NAME="toString()"><!-- --></A><H3>
  548. toString</H3>
  549. <PRE>
  550. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
  551. <DL>
  552. <DD><DL>
  553. <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL>
  554. </DD>
  555. </DL>
  556. <!-- ========= END OF CLASS DATA ========= -->
  557. <HR>
  558.  
  559. <!-- ========== START OF NAVBAR ========== -->
  560. <A NAME="navbar_bottom"><!-- --></A>
  561. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  562. <TR>
  563. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  564. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  565. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  566.   <TR ALIGN="center" VALIGN="top">
  567.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  568.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  569.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/P4Process.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  570.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  571.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  572.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  573.   </TR>
  574. </TABLE>
  575. </TD>
  576. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  577. <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>
  578. </TD>
  579. </TR>
  580.  
  581. <TR>
  582. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  583. &nbsp;<A HREF="../../../com/perforce/api/P4JNI.html"><B>PREV CLASS</B></A>&nbsp;
  584. &nbsp;NEXT CLASS</FONT></TD>
  585. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  586.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  587. &nbsp;<A HREF="P4Process.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  588. </TR>
  589. <TR>
  590. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  591.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  592. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  593. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  594. </TR>
  595. </TABLE>
  596. <!-- =========== END OF NAVBAR =========== -->
  597.  
  598. <HR>
  599. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  600. </BODY>
  601. </HTML>
# Change User Description Committed
#7 2001 David Markley Updated package documentation. 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 1148 David Markley Added a few examples and a server connection timeout threshold. 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