Helix SwarmHelix Swarm

Env.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • Env.html #7
  • View
  • Commits
  • Open Download .zip Download (42 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  Env
  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/Env.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/DirEntry.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/EventLog.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="Env.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  Env</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.Env</B>
  63. </PRE>
  64. <HR>
  65. <DL>
  66. <DT>public class <B>Env</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. Representation of a source control environment. This information is
  70.  typically passed to a <code>P4Process</code> instance by the
  71.  <code>SourceControlObject</code> instances. It can also be set in the
  72.  <A HREF="../../../com/perforce/api/P4Process.html#getBase()"><CODE>base</CODE></A> P4Process instance. This will cause it
  73.  to be used as the default environment for all command execution.
  74.  <P>
  75.  Values for the environment can be easily loaded from a
  76.  <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html"><CODE>Properties</CODE></A> file. This makes configuration of
  77.  the environment much simpler.
  78. <P>
  79. <DL>
  80. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #7 $</DD>
  81. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  82. <DT><B>See Also: </B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html"><CODE>Properties</CODE></A></DL>
  83. <HR>
  84.  
  85. <P>
  86. <!-- ======== INNER CLASS SUMMARY ======== -->
  87.  
  88.  
  89. <!-- =========== FIELD SUMMARY =========== -->
  90.  
  91.  
  92. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  93.  
  94. <A NAME="constructor_summary"><!-- --></A>
  95. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  96. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  97. <TD COLSPAN=2><FONT SIZE="+2">
  98. <B>Constructor Summary</B></FONT></TD>
  99. </TR>
  100. <TR BGCOLOR="white" CLASS="TableRowColor">
  101. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#Env()">Env</A></B>()</CODE>
  102.  
  103. <BR>
  104. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default, no-argument constructor.</TD>
  105. </TR>
  106. <TR BGCOLOR="white" CLASS="TableRowColor">
  107. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#Env(com.perforce.api.Env)">Env</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;base)</CODE>
  108.  
  109. <BR>
  110. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that uses another environment as its basis.</TD>
  111. </TR>
  112. <TR BGCOLOR="white" CLASS="TableRowColor">
  113. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#Env(java.util.Properties)">Env</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html">Properties</A>&nbsp;props)</CODE>
  114.  
  115. <BR>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that uses a set of <code>Properties</code> to set up the
  117.  environment.</TD>
  118. </TR>
  119. <TR BGCOLOR="white" CLASS="TableRowColor">
  120. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#Env(java.lang.String)">Env</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;propfile)</CODE>
  121.  
  122. <BR>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an environment from a properties file.</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;void</CODE></FONT></TD>
  138. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#appendPath(java.lang.String)">appendPath</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
  139.  
  140. <BR>
  141. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Append the path element to the existing path.</TD>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  145. <CODE>&nbsp;void</CODE></FONT></TD>
  146. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#checkValidity()">checkValidity</A></B>()</CODE>
  147.  
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the environment to see if it is valid.</TD>
  150. </TR>
  151. <TR BGCOLOR="white" CLASS="TableRowColor">
  152. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  153. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  154. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getClient()">getClient</A></B>()</CODE>
  155.  
  156. <BR>
  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the P4CLIENT.</TD>
  158. </TR>
  159. <TR BGCOLOR="white" CLASS="TableRowColor">
  160. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  161. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  162. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getenv(java.lang.String)">getenv</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  163.  
  164. <BR>
  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value for the named environment variable.</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/Env.html#getEnvp()">getEnvp</A></B>()</CODE>
  171.  
  172. <BR>
  173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the environment in a <code>String</code> array.</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/Env.html#getExecutable()">getExecutable</A></B>()</CODE>
  179.  
  180. <BR>
  181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the path to the executable.</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/Env.html#getPassword()">getPassword</A></B>()</CODE>
  187.  
  188. <BR>
  189. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the P4PASSWORD.</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/Env.html#getPath()">getPath</A></B>()</CODE>
  195.  
  196. <BR>
  197. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the PATH.</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="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  202. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getPort()">getPort</A></B>()</CODE>
  203.  
  204. <BR>
  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the P4PORT.</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="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html">Properties</A></CODE></FONT></TD>
  210. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getProperties()">getProperties</A></B>()</CODE>
  211.  
  212. <BR>
  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new <code>Properties</code> instance that is set using the
  214.  environments properties as its default.</TD>
  215. </TR>
  216. <TR BGCOLOR="white" CLASS="TableRowColor">
  217. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  218. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  219. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getProperty(java.lang.String)">getProperty</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key)</CODE>
  220.  
  221. <BR>
  222. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches for the property with the specified key in this property list.</TD>
  223. </TR>
  224. <TR BGCOLOR="white" CLASS="TableRowColor">
  225. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  226. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  227. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getProperty(java.lang.String, java.lang.String)">getProperty</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  228.             <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;defaultValue)</CODE>
  229.  
  230. <BR>
  231. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches for the property with the specified key in this property list.</TD>
  232. </TR>
  233. <TR BGCOLOR="white" CLASS="TableRowColor">
  234. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  235. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A></CODE></FONT></TD>
  236. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getPropertyList(java.lang.String, java.lang.String)">getPropertyList</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  237.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;defaultValue)</CODE>
  238.  
  239. <BR>
  240. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>Vector</code> containing the property value list, as split up
  241.  by the commas.</TD>
  242. </TR>
  243. <TR BGCOLOR="white" CLASS="TableRowColor">
  244. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  245. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A></CODE></FONT></TD>
  246. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getPropertyList(java.lang.String, java.lang.String, java.lang.String)">getPropertyList</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  247.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;defaultValue,
  248.                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;delimeter)</CODE>
  249.  
  250. <BR>
  251. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>Vector</code> containing the property value list, as split up
  252.  by the specified delimeter.</TD>
  253. </TR>
  254. <TR BGCOLOR="white" CLASS="TableRowColor">
  255. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  256. <CODE>&nbsp;long</CODE></FONT></TD>
  257. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getServerTimeout()">getServerTimeout</A></B>()</CODE>
  258.  
  259. <BR>
  260. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the server timeout threshold.</TD>
  261. </TR>
  262. <TR BGCOLOR="white" CLASS="TableRowColor">
  263. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  264. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  265. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#getUser()">getUser</A></B>()</CODE>
  266.  
  267. <BR>
  268. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the P4USER.</TD>
  269. </TR>
  270. <TR BGCOLOR="white" CLASS="TableRowColor">
  271. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  272. <CODE>&nbsp;void</CODE></FONT></TD>
  273. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setClient(java.lang.String)">setClient</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;client)</CODE>
  274.  
  275. <BR>
  276. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the P4CLIENT in the class information.</TD>
  277. </TR>
  278. <TR BGCOLOR="white" CLASS="TableRowColor">
  279. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  280. <CODE>&nbsp;void</CODE></FONT></TD>
  281. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setenv(java.lang.String, java.lang.String)">setenv</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
  282.        <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;value)</CODE>
  283.  
  284. <BR>
  285. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows the user to set any environment variable.</TD>
  286. </TR>
  287. <TR BGCOLOR="white" CLASS="TableRowColor">
  288. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  289. <CODE>&nbsp;void</CODE></FONT></TD>
  290. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setExecutable(java.lang.String)">setExecutable</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;exe)</CODE>
  291.  
  292. <BR>
  293. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets up the path to reach the p4 executable.</TD>
  294. </TR>
  295. <TR BGCOLOR="white" CLASS="TableRowColor">
  296. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  297. <CODE>&nbsp;void</CODE></FONT></TD>
  298. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setFromProperties(java.util.Properties)">setFromProperties</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html">Properties</A>&nbsp;props)</CODE>
  299.  
  300. <BR>
  301. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Uses a set of <code>Properties</code> to set up the environment.</TD>
  302. </TR>
  303. <TR BGCOLOR="white" CLASS="TableRowColor">
  304. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  305. <CODE>&nbsp;void</CODE></FONT></TD>
  306. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setFromProperties(java.lang.String)">setFromProperties</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;propfile)</CODE>
  307.  
  308. <BR>
  309. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the environment using the specified properties file.</TD>
  310. </TR>
  311. <TR BGCOLOR="white" CLASS="TableRowColor">
  312. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  313. <CODE>&nbsp;void</CODE></FONT></TD>
  314. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setPassword(java.lang.String)">setPassword</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;password)</CODE>
  315.  
  316. <BR>
  317. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the P4PASSWD in the class information.</TD>
  318. </TR>
  319. <TR BGCOLOR="white" CLASS="TableRowColor">
  320. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  321. <CODE>&nbsp;void</CODE></FONT></TD>
  322. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.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>
  323.  
  324. <BR>
  325. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the PATH in the class information.</TD>
  326. </TR>
  327. <TR BGCOLOR="white" CLASS="TableRowColor">
  328. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  329. <CODE>&nbsp;void</CODE></FONT></TD>
  330. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setPort(java.lang.String)">setPort</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;port)</CODE>
  331.  
  332. <BR>
  333. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the P4PORT in the class information.</TD>
  334. </TR>
  335. <TR BGCOLOR="white" CLASS="TableRowColor">
  336. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  337. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  338. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setProperty(java.lang.String, java.lang.String)">setProperty</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  339.             <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;value)</CODE>
  340.  
  341. <BR>
  342. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls the hashtable method put.</TD>
  343. </TR>
  344. <TR BGCOLOR="white" CLASS="TableRowColor">
  345. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  346. <CODE>&nbsp;void</CODE></FONT></TD>
  347. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setServerTimeout(long)">setServerTimeout</A></B>(long&nbsp;threshold)</CODE>
  348.  
  349. <BR>
  350. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the server timeout threshold.</TD>
  351. </TR>
  352. <TR BGCOLOR="white" CLASS="TableRowColor">
  353. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  354. <CODE>&nbsp;void</CODE></FONT></TD>
  355. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setSystemDrive(java.lang.String)">setSystemDrive</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;drive)</CODE>
  356.  
  357. <BR>
  358. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the SystemDrive in the class information.</TD>
  359. </TR>
  360. <TR BGCOLOR="white" CLASS="TableRowColor">
  361. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  362. <CODE>&nbsp;void</CODE></FONT></TD>
  363. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setSystemRoot(java.lang.String)">setSystemRoot</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;root)</CODE>
  364.  
  365. <BR>
  366. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the SystemRoot in the class information.</TD>
  367. </TR>
  368. <TR BGCOLOR="white" CLASS="TableRowColor">
  369. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  370. <CODE>&nbsp;void</CODE></FONT></TD>
  371. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#setUser(java.lang.String)">setUser</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;user)</CODE>
  372.  
  373. <BR>
  374. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the P4USER in the class information.</TD>
  375. </TR>
  376. <TR BGCOLOR="white" CLASS="TableRowColor">
  377. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  378. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  379. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#toString()">toString</A></B>()</CODE>
  380.  
  381. <BR>
  382. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  383. </TR>
  384. <TR BGCOLOR="white" CLASS="TableRowColor">
  385. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  386. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  387. <TD><CODE><B><A HREF="../../../com/perforce/api/Env.html#toXML()">toXML</A></B>()</CODE>
  388.  
  389. <BR>
  390. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an XML representation of the environment.</TD>
  391. </TR>
  392. </TABLE>
  393. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  394. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  395. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  396. <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>
  397. </TR>
  398. <TR BGCOLOR="white" CLASS="TableRowColor">
  399. <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>
  400. </TR>
  401. </TABLE>
  402. &nbsp;
  403. <P>
  404.  
  405. <!-- ============ FIELD DETAIL =========== -->
  406.  
  407.  
  408. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  409.  
  410. <A NAME="constructor_detail"><!-- --></A>
  411. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  412. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  413. <TD COLSPAN=1><FONT SIZE="+2">
  414. <B>Constructor Detail</B></FONT></TD>
  415. </TR>
  416. </TABLE>
  417.  
  418. <A NAME="Env()"><!-- --></A><H3>
  419. Env</H3>
  420. <PRE>
  421. public <B>Env</B>()</PRE>
  422. <DL>
  423. <DD>Default, no-argument constructor.</DL>
  424. <HR>
  425.  
  426. <A NAME="Env(com.perforce.api.Env)"><!-- --></A><H3>
  427. Env</H3>
  428. <PRE>
  429. public <B>Env</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;base)</PRE>
  430. <DL>
  431. <DD>Constructor that uses another environment as its basis. This is useful
  432.  for cloning environments and then changing a few attributes.<DD><DL>
  433. <DT><B>Parameters:</B><DD><CODE>base</CODE> - Environment to be copied into the new environment.</DL>
  434. </DD>
  435. </DL>
  436. <HR>
  437.  
  438. <A NAME="Env(java.util.Properties)"><!-- --></A><H3>
  439. Env</H3>
  440. <PRE>
  441. public <B>Env</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html">Properties</A>&nbsp;props)</PRE>
  442. <DL>
  443. <DD>Constructor that uses a set of <code>Properties</code> to set up the
  444.  environment.<DD><DL>
  445. <DT><B>Parameters:</B><DD><CODE>props</CODE> - Used to construct the environment.<DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Env.html#setFromProperties(java.util.Properties)"><CODE>setFromProperties(Properties)</CODE></A></DL>
  446. </DD>
  447. </DL>
  448. <HR>
  449.  
  450. <A NAME="Env(java.lang.String)"><!-- --></A><H3>
  451. Env</H3>
  452. <PRE>
  453. public <B>Env</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;propfile)
  454.     throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  455. <DL>
  456. <DD>Constructs an environment from a properties file.<DD><DL>
  457. <DT><B>Parameters:</B><DD><CODE>propfile</CODE> - full path to a properties file.</DL>
  458. </DD>
  459. </DL>
  460.  
  461. <!-- ============ METHOD DETAIL ========== -->
  462.  
  463. <A NAME="method_detail"><!-- --></A>
  464. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  465. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  466. <TD COLSPAN=1><FONT SIZE="+2">
  467. <B>Method Detail</B></FONT></TD>
  468. </TR>
  469. </TABLE>
  470.  
  471. <A NAME="appendPath(java.lang.String)"><!-- --></A><H3>
  472. appendPath</H3>
  473. <PRE>
  474. public void <B>appendPath</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
  475. <DL>
  476. <DD>Append the path element to the existing path. If the path element
  477.  given is already in the path, no change is made.<DD><DL>
  478. <DT><B>Parameters:</B><DD><CODE>path</CODE> - the path element to be appended.</DL>
  479. </DD>
  480. </DL>
  481. <HR>
  482.  
  483. <A NAME="checkValidity()"><!-- --></A><H3>
  484. checkValidity</H3>
  485. <PRE>
  486. public void <B>checkValidity</B>()
  487.                    throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  488. <DL>
  489. <DD>Checks the environment to see if it is valid. To check the validity of
  490.  the environment, the user information is accessed. This ensures that
  491.  the server can be contacted and that the password is set properly.
  492.  <p>
  493.  If the environment is valid, this method will return quietly. Otherwise,
  494.  it will throw a <code>PerforceException</code> with a message regarding
  495.  the failure.</DL>
  496. <HR>
  497.  
  498. <A NAME="getClient()"><!-- --></A><H3>
  499. getClient</H3>
  500. <PRE>
  501. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getClient</B>()</PRE>
  502. <DL>
  503. <DD>Returns the P4CLIENT.</DL>
  504. <HR>
  505.  
  506. <A NAME="getenv(java.lang.String)"><!-- --></A><H3>
  507. getenv</H3>
  508. <PRE>
  509. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getenv</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  510. <DL>
  511. <DD>Returns the value for the named environment variable.<DD><DL>
  512. <DT><B>Parameters:</B><DD><CODE>name</CODE> - environment variable name</DL>
  513. </DD>
  514. </DL>
  515. <HR>
  516.  
  517. <A NAME="getEnvp()"><!-- --></A><H3>
  518. getEnvp</H3>
  519. <PRE>
  520. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getEnvp</B>()</PRE>
  521. <DL>
  522. <DD>Returns the environment in a <code>String</code> array.</DL>
  523. <HR>
  524.  
  525. <A NAME="getExecutable()"><!-- --></A><H3>
  526. getExecutable</H3>
  527. <PRE>
  528. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getExecutable</B>()</PRE>
  529. <DL>
  530. <DD>Returns the path to the executable.</DL>
  531. <HR>
  532.  
  533. <A NAME="getPassword()"><!-- --></A><H3>
  534. getPassword</H3>
  535. <PRE>
  536. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getPassword</B>()</PRE>
  537. <DL>
  538. <DD>Returns the P4PASSWORD.</DL>
  539. <HR>
  540.  
  541. <A NAME="getPath()"><!-- --></A><H3>
  542. getPath</H3>
  543. <PRE>
  544. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getPath</B>()</PRE>
  545. <DL>
  546. <DD>Returns the PATH.</DL>
  547. <HR>
  548.  
  549. <A NAME="getPort()"><!-- --></A><H3>
  550. getPort</H3>
  551. <PRE>
  552. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getPort</B>()</PRE>
  553. <DL>
  554. <DD>Returns the P4PORT.</DL>
  555. <HR>
  556.  
  557. <A NAME="getProperties()"><!-- --></A><H3>
  558. getProperties</H3>
  559. <PRE>
  560. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html">Properties</A> <B>getProperties</B>()</PRE>
  561. <DL>
  562. <DD>Returns a new <code>Properties</code> instance that is set using the
  563.  environments properties as its default.</DL>
  564. <HR>
  565.  
  566. <A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
  567. getProperty</H3>
  568. <PRE>
  569. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getProperty</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key)</PRE>
  570. <DL>
  571. <DD>Searches for the property with the specified key in this property list.
  572.  If the key is not found in this property list, the default property list,
  573.  and its defaults, recursively, are then checked. The method returns null
  574.  if the property is not found.<DD><DL>
  575. <DT><B>Parameters:</B><DD><CODE>key</CODE> - the property key<DT><B>Returns:</B><DD>the value in this property list with the specified key value<DT><B>See Also: </B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html"><CODE>Properties</CODE></A></DL>
  576. </DD>
  577. </DL>
  578. <HR>
  579.  
  580. <A NAME="getProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
  581. getProperty</H3>
  582. <PRE>
  583. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getProperty</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  584.                           <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;defaultValue)</PRE>
  585. <DL>
  586. <DD>Searches for the property with the specified key in this property list.
  587.  If the key is not found in this property list, the default property list,
  588.  and its defaults, recursively, are then checked. The method returns
  589.  the default value argument if the property is not found.<DD><DL>
  590. <DT><B>Parameters:</B><DD><CODE>key</CODE> - the property key<DD><CODE>defaultValue</CODE> - a default value<DT><B>Returns:</B><DD>the value in this property list with the specified key value<DT><B>See Also: </B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html"><CODE>Properties</CODE></A></DL>
  591. </DD>
  592. </DL>
  593. <HR>
  594.  
  595. <A NAME="getPropertyList(java.lang.String, java.lang.String)"><!-- --></A><H3>
  596. getPropertyList</H3>
  597. <PRE>
  598. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A> <B>getPropertyList</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  599.                               <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;defaultValue)</PRE>
  600. <DL>
  601. <DD>Returns a <code>Vector</code> containing the property value list, as split up
  602.  by the commas. This is used to get the values for a property in the
  603.  form of:
  604.  <p>
  605.  some.property.key=val1,val2,val3
  606.  <p>
  607.  Will always return a <code>Vector</code>, even if it is empty.<DD><DL>
  608. <DT><B>Parameters:</B><DD><CODE>key</CODE> - the property key<DD><CODE>defaultValue</CODE> - a default value</DL>
  609. </DD>
  610. </DL>
  611. <HR>
  612.  
  613. <A NAME="getPropertyList(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  614. getPropertyList</H3>
  615. <PRE>
  616. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A> <B>getPropertyList</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  617.                               <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;defaultValue,
  618.                               <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;delimeter)</PRE>
  619. <DL>
  620. <DD>Returns a <code>Vector</code> containing the property value list, as split up
  621.  by the specified delimeter. This is used to get the values for a property in the
  622.  form of:
  623.  <p>
  624.  some.property.key=val1,val2,val3
  625.  <p>
  626.  Will always return a <code>Vector</code>, even if it is empty.<DD><DL>
  627. <DT><B>Parameters:</B><DD><CODE>key</CODE> - the property key<DD><CODE>defaultValue</CODE> - a default value<DD><CODE>delimeter</CODE> - string that seperates the values</DL>
  628. </DD>
  629. </DL>
  630. <HR>
  631.  
  632. <A NAME="getServerTimeout()"><!-- --></A><H3>
  633. getServerTimeout</H3>
  634. <PRE>
  635. public long <B>getServerTimeout</B>()</PRE>
  636. <DL>
  637. <DD>Return the server timeout threshold.</DL>
  638. <HR>
  639.  
  640. <A NAME="getUser()"><!-- --></A><H3>
  641. getUser</H3>
  642. <PRE>
  643. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getUser</B>()</PRE>
  644. <DL>
  645. <DD>Returns the P4USER.</DL>
  646. <HR>
  647.  
  648. <A NAME="setClient(java.lang.String)"><!-- --></A><H3>
  649. setClient</H3>
  650. <PRE>
  651. public void <B>setClient</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;client)</PRE>
  652. <DL>
  653. <DD>Sets the P4CLIENT in the class information.<DD><DL>
  654. <DT><B>Parameters:</B><DD><CODE>user</CODE> - P4CLIENT value.</DL>
  655. </DD>
  656. </DL>
  657. <HR>
  658.  
  659. <A NAME="setenv(java.lang.String, java.lang.String)"><!-- --></A><H3>
  660. setenv</H3>
  661. <PRE>
  662. public void <B>setenv</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
  663.                    <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;value)</PRE>
  664. <DL>
  665. <DD>Allows the user to set any environment variable. If the variable name
  666.  starts with 'P4', the value can not be set to null. It will instead be
  667.  set to the empty string. For all other variable, supplying a null
  668.  value will remove that variable form the environment.<DD><DL>
  669. <DT><B>Parameters:</B><DD><CODE>name</CODE> - environment variable name<DD><CODE>value</CODE> - environment variable value</DL>
  670. </DD>
  671. </DL>
  672. <HR>
  673.  
  674. <A NAME="setExecutable(java.lang.String)"><!-- --></A><H3>
  675. setExecutable</H3>
  676. <PRE>
  677. public void <B>setExecutable</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;exe)</PRE>
  678. <DL>
  679. <DD>Sets up the path to reach the p4 executable. The full path passed in must
  680.  contain the executable or at least end in the system's file separator
  681.  character. This gotten from the file.separator property. For example:
  682.  <pre>
  683.  p4.executable=/usr/bin/p4   # This will work
  684.  p4.executable=/usr/bin/     # This will work
  685.  <font color=Red>p4.executable=/usr/bin      # This won't work</font>
  686.  </pre><DD><DL>
  687. <DT><B>Parameters:</B><DD><CODE>exe</CODE> - Full path to the p4 executable.</DL>
  688. </DD>
  689. </DL>
  690. <HR>
  691.  
  692. <A NAME="setFromProperties(java.util.Properties)"><!-- --></A><H3>
  693. setFromProperties</H3>
  694. <PRE>
  695. public void <B>setFromProperties</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html">Properties</A>&nbsp;props)</PRE>
  696. <DL>
  697. <DD>Uses a set of <code>Properties</code> to set up the environment. The
  698.  properties that are used used by this method are:
  699.  
  700.  <table border="1">
  701.  <thead><tr><th>Property</th><th>Value Set</th></tr></thead><tbody>
  702.  <tr><td>p4.user</td><td>P4USER</td></tr>
  703.  <tr><td>p4.client</td><td>P4CLIENT</td></tr>
  704.  <tr><td>p4.port</td><td>P4PORT</td></tr>
  705.  <tr><td>p4.password</td><td>P4PASSWORD</td></tr>
  706.  <tr><td>p4.executable</td><td>Executable</td></tr>
  707.  <tr><td>p4.sysdrive</td><td>SystemDrive</td></tr>
  708.  <tr><td>p4.sysroot</td><td>SystemRoot</td></tr>
  709.  <tr><td>p4.threshold</td><td>Server Timeout Threshold</td></tr>
  710.  </tbody></table><DD><DL>
  711. <DT><B>Parameters:</B><DD><CODE>props</CODE> - Used to construct the environment.</DL>
  712. </DD>
  713. </DL>
  714. <HR>
  715.  
  716. <A NAME="setFromProperties(java.lang.String)"><!-- --></A><H3>
  717. setFromProperties</H3>
  718. <PRE>
  719. public void <B>setFromProperties</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;propfile)
  720.                        throws <A HREF="../../../com/perforce/api/PerforceException.html">PerforceException</A></PRE>
  721. <DL>
  722. <DD>Sets the environment using the specified properties file.<DD><DL>
  723. <DT><B>Parameters:</B><DD><CODE>propfile</CODE> - Path to a properties file.<DT><B>See Also: </B><DD><A HREF="../../../com/perforce/api/Env.html#setFromProperties(java.util.Properties)"><CODE>setFromProperties(Properties)</CODE></A></DL>
  724. </DD>
  725. </DL>
  726. <HR>
  727.  
  728. <A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
  729. setPassword</H3>
  730. <PRE>
  731. public void <B>setPassword</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;password)</PRE>
  732. <DL>
  733. <DD>Sets the P4PASSWD in the class information.<DD><DL>
  734. <DT><B>Parameters:</B><DD><CODE>user</CODE> - P4PASSWD value.</DL>
  735. </DD>
  736. </DL>
  737. <HR>
  738.  
  739. <A NAME="setPath(java.lang.String)"><!-- --></A><H3>
  740. setPath</H3>
  741. <PRE>
  742. 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>
  743. <DL>
  744. <DD>Sets the PATH in the class information.<DD><DL>
  745. <DT><B>Parameters:</B><DD><CODE>path</CODE> - PATH value.</DL>
  746. </DD>
  747. </DL>
  748. <HR>
  749.  
  750. <A NAME="setPort(java.lang.String)"><!-- --></A><H3>
  751. setPort</H3>
  752. <PRE>
  753. public void <B>setPort</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;port)</PRE>
  754. <DL>
  755. <DD>Sets the P4PORT in the class information.<DD><DL>
  756. <DT><B>Parameters:</B><DD><CODE>user</CODE> - P4PORT value.</DL>
  757. </DD>
  758. </DL>
  759. <HR>
  760.  
  761. <A NAME="setProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
  762. setProperty</H3>
  763. <PRE>
  764. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>setProperty</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;key,
  765.                           <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;value)</PRE>
  766. <DL>
  767. <DD>Calls the hashtable method put. Provided for parallelism with the
  768.  getProperty method. Enforces use of strings for property keys and values.<DD><DL>
  769. <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key to be placed into this property list.<DD><CODE>value</CODE> - the value corresponding to key.<DT><B>See Also: </B><DD><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Properties.html#setProperty(java.lang.String, java.lang.String)"><CODE>Properties.setProperty(String,String)</CODE></A></DL>
  770. </DD>
  771. </DL>
  772. <HR>
  773.  
  774. <A NAME="setServerTimeout(long)"><!-- --></A><H3>
  775. setServerTimeout</H3>
  776. <PRE>
  777. public void <B>setServerTimeout</B>(long&nbsp;threshold)</PRE>
  778. <DL>
  779. <DD>Set the server timeout threshold.</DL>
  780. <HR>
  781.  
  782. <A NAME="setSystemDrive(java.lang.String)"><!-- --></A><H3>
  783. setSystemDrive</H3>
  784. <PRE>
  785. public void <B>setSystemDrive</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;drive)</PRE>
  786. <DL>
  787. <DD>Sets the SystemDrive in the class information. This is only
  788.  meaningful under Windows.<DD><DL>
  789. <DT><B>Parameters:</B><DD><CODE>user</CODE> - SystemDrive value.</DL>
  790. </DD>
  791. </DL>
  792. <HR>
  793.  
  794. <A NAME="setSystemRoot(java.lang.String)"><!-- --></A><H3>
  795. setSystemRoot</H3>
  796. <PRE>
  797. public void <B>setSystemRoot</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;root)</PRE>
  798. <DL>
  799. <DD>Sets the SystemRoot in the class information. This is only
  800.  meaningful under Windows.<DD><DL>
  801. <DT><B>Parameters:</B><DD><CODE>user</CODE> - SystemRoot value.</DL>
  802. </DD>
  803. </DL>
  804. <HR>
  805.  
  806. <A NAME="setUser(java.lang.String)"><!-- --></A><H3>
  807. setUser</H3>
  808. <PRE>
  809. public void <B>setUser</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;user)</PRE>
  810. <DL>
  811. <DD>Sets the P4USER in the class information.<DD><DL>
  812. <DT><B>Parameters:</B><DD><CODE>user</CODE> - P4USER value.</DL>
  813. </DD>
  814. </DL>
  815. <HR>
  816.  
  817. <A NAME="toString()"><!-- --></A><H3>
  818. toString</H3>
  819. <PRE>
  820. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
  821. <DL>
  822. <DD><DL>
  823. <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>
  824. </DD>
  825. </DL>
  826. <HR>
  827.  
  828. <A NAME="toXML()"><!-- --></A><H3>
  829. toXML</H3>
  830. <PRE>
  831. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  832. <DL>
  833. <DD>Returns an XML representation of the environment.</DL>
  834. <!-- ========= END OF CLASS DATA ========= -->
  835. <HR>
  836.  
  837. <!-- ========== START OF NAVBAR ========== -->
  838. <A NAME="navbar_bottom"><!-- --></A>
  839. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  840. <TR>
  841. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  842. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  843. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  844.   <TR ALIGN="center" VALIGN="top">
  845.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  846.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  847.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Env.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  848.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  849.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  850.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  851.   </TR>
  852. </TABLE>
  853. </TD>
  854. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  855. <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>
  856. </TD>
  857. </TR>
  858.  
  859. <TR>
  860. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  861. &nbsp;<A HREF="../../../com/perforce/api/DirEntry.html"><B>PREV CLASS</B></A>&nbsp;
  862. &nbsp;<A HREF="../../../com/perforce/api/EventLog.html"><B>NEXT CLASS</B></A></FONT></TD>
  863. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  864.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  865. &nbsp;<A HREF="Env.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  866. </TR>
  867. <TR>
  868. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  869.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  870. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  871. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  872. </TR>
  873. </TABLE>
  874. <!-- =========== END OF NAVBAR =========== -->
  875.  
  876. <HR>
  877. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  878. </BODY>
  879. </HTML>
# Change User Description Committed
#7 2001 David Markley Updated package documentation. 23 years ago
#6 1386 David Markley Updated the documentation. 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