Helix SwarmHelix Swarm

Mapping.html

  • //
  • guest/
  • david_markley/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • Mapping.html #6
  • View
  • Commits
  • Open Download .zip Download (25 KB) 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc on Mon Aug 05 13:17:01 EDT 2002 -->
  6. <TITLE>
  7. Perforce API: Class  Mapping
  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/Mapping.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/Label.html"><B>PREV CLASS</B></A>&nbsp;
  38. &nbsp;<A HREF="../../../com/perforce/api/P4JNI.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="Mapping.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  Mapping</H2>
  59. <PRE>
  60. <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
  61.   |
  62.   +--<A HREF="../../../com/perforce/api/SourceControlObject.html">com.perforce.api.SourceControlObject</A>
  63.         |
  64.         +--<B>com.perforce.api.Mapping</B>
  65. </PRE>
  66. <DL>
  67. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Comparable.html">Comparable</A></DD>
  68. </DL>
  69. <DL>
  70. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/perforce/api/Branch.html">Branch</A>, <A HREF="../../../com/perforce/api/Client.html">Client</A>, <A HREF="../../../com/perforce/api/Label.html">Label</A></DD>
  71. </DL>
  72. <HR>
  73. <DL>
  74. <DT>public abstract class <B>Mapping</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A><DT>implements <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Comparable.html">Comparable</A></DL>
  75.  
  76. <P>
  77. Representation of a source control mapping. This handles a named set of file
  78.  mappings.
  79. <P>
  80. <DL>
  81. <DT><B>Version: </B><DD>$Date: 2002/08/05 $ $Revision: #6 $</DD>
  82. <DT><B>Author: </B><DD><a href="mailto:david@markley.cc">David Markley</a></DD>
  83. </DL>
  84. <HR>
  85.  
  86. <P>
  87. <!-- ======== INNER CLASS SUMMARY ======== -->
  88.  
  89.  
  90. <!-- =========== FIELD SUMMARY =========== -->
  91.  
  92.  
  93. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  94.  
  95. <A NAME="constructor_summary"><!-- --></A>
  96. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  97. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  98. <TD COLSPAN=2><FONT SIZE="+2">
  99. <B>Constructor Summary</B></FONT></TD>
  100. </TR>
  101. <TR BGCOLOR="white" CLASS="TableRowColor">
  102. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#Mapping()">Mapping</A></B>()</CODE>
  103.  
  104. <BR>
  105. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default no-argument constructor.</TD>
  106. </TR>
  107. <TR BGCOLOR="white" CLASS="TableRowColor">
  108. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#Mapping(java.lang.String)">Mapping</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  109.  
  110. <BR>
  111. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that is passed the mapping name.</TD>
  112. </TR>
  113. </TABLE>
  114. &nbsp;
  115. <!-- ========== METHOD SUMMARY =========== -->
  116.  
  117. <A NAME="method_summary"><!-- --></A>
  118. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  119. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  120. <TD COLSPAN=2><FONT SIZE="+2">
  121. <B>Method Summary</B></FONT></TD>
  122. </TR>
  123. <TR BGCOLOR="white" CLASS="TableRowColor">
  124. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  125. <CODE>&nbsp;void</CODE></FONT></TD>
  126. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String)">addView</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;line)</CODE>
  127.  
  128. <BR>
  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  130. </TR>
  131. <TR BGCOLOR="white" CLASS="TableRowColor">
  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  133. <CODE>&nbsp;void</CODE></FONT></TD>
  134. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String, java.lang.String)">addView</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;from,
  135.         <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;to)</CODE>
  136.  
  137. <BR>
  138. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a view to the Mapping.</TD>
  139. </TR>
  140. <TR BGCOLOR="white" CLASS="TableRowColor">
  141. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  142. <CODE>abstract &nbsp;void</CODE></FONT></TD>
  143. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#commit()">commit</A></B>()</CODE>
  144.  
  145. <BR>
  146. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores this object back into Perforce, creating it if it
  147.  didn't already exist.</TD>
  148. </TR>
  149. <TR BGCOLOR="white" CLASS="TableRowColor">
  150. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  151. <CODE>&nbsp;int</CODE></FONT></TD>
  152. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>&nbsp;o)</CODE>
  153.  
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#getDescription()">getDescription</A></B>()</CODE>
  161.  
  162. <BR>
  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Mapping description.</TD>
  164. </TR>
  165. <TR BGCOLOR="white" CLASS="TableRowColor">
  166. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  167. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  168. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#getName()">getName</A></B>()</CODE>
  169.  
  170. <BR>
  171. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the Mapping.</TD>
  172. </TR>
  173. <TR BGCOLOR="white" CLASS="TableRowColor">
  174. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  175. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  176. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#getOwner()">getOwner</A></B>()</CODE>
  177.  
  178. <BR>
  179. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the owner of the Mapping.</TD>
  180. </TR>
  181. <TR BGCOLOR="white" CLASS="TableRowColor">
  182. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  183. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  184. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#getView()">getView</A></B>()</CODE>
  185.  
  186. <BR>
  187. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  188. </TR>
  189. <TR BGCOLOR="white" CLASS="TableRowColor">
  190. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  191. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  192. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#getViews()">getViews</A></B>()</CODE>
  193.  
  194. <BR>
  195. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  196. </TR>
  197. <TR BGCOLOR="white" CLASS="TableRowColor">
  198. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  199. <CODE>static&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A></CODE></FONT></TD>
  200. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#lookupMappings(com.perforce.api.HashDecay, java.lang.String)">lookupMappings</A></B>(<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A>&nbsp;mappings,
  201.                <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;prefix)</CODE>
  202.  
  203. <BR>
  204. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of mappings that begin with the specified prefix.</TD>
  205. </TR>
  206. <TR BGCOLOR="white" CLASS="TableRowColor">
  207. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  208. <CODE>&nbsp;void</CODE></FONT></TD>
  209. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#setDescription(java.lang.String)">setDescription</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;description)</CODE>
  210.  
  211. <BR>
  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the description for the Mapping.</TD>
  213. </TR>
  214. <TR BGCOLOR="white" CLASS="TableRowColor">
  215. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  216. <CODE>&nbsp;void</CODE></FONT></TD>
  217. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  218.  
  219. <BR>
  220. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the name of the Mapping.</TD>
  221. </TR>
  222. <TR BGCOLOR="white" CLASS="TableRowColor">
  223. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  224. <CODE>&nbsp;void</CODE></FONT></TD>
  225. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#setOwner(java.lang.String)">setOwner</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;owner)</CODE>
  226.  
  227. <BR>
  228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the owner of the Mapping.</TD>
  229. </TR>
  230. <TR BGCOLOR="white" CLASS="TableRowColor">
  231. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  232. <CODE>abstract &nbsp;void</CODE></FONT></TD>
  233. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#sync(java.lang.String)">sync</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
  234.  
  235. <BR>
  236. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronizes the Mapping with the latest information from P4.</TD>
  237. </TR>
  238. <TR BGCOLOR="white" CLASS="TableRowColor">
  239. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  240. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  241. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#toString()">toString</A></B>()</CODE>
  242.  
  243. <BR>
  244. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  245. </TR>
  246. <TR BGCOLOR="white" CLASS="TableRowColor">
  247. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  248. <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
  249. <TD><CODE><B><A HREF="../../../com/perforce/api/Mapping.html#toXML()">toXML</A></B>()</CODE>
  250.  
  251. <BR>
  252. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
  253. </TR>
  254. </TABLE>
  255. &nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
  256. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  257. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  258. <TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD>
  259. </TR>
  260. <TR BGCOLOR="white" CLASS="TableRowColor">
  261. <TD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#clearCache()">clearCache</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">getCache</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getEnv()">getEnv</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getSyncTime()">getSyncTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getUpdateTime()">getUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#inSync()">inSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#invalidate()">invalidate</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#outOfSync(long)">outOfSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#refreshUpdateTime()">refreshUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#setEnv(com.perforce.api.Env)">setEnv</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></CODE></TD>
  262. </TR>
  263. </TABLE>
  264. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  265. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  266. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  267. <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>
  268. </TR>
  269. <TR BGCOLOR="white" CLASS="TableRowColor">
  270. <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>
  271. </TR>
  272. </TABLE>
  273. &nbsp;
  274. <P>
  275.  
  276. <!-- ============ FIELD DETAIL =========== -->
  277.  
  278.  
  279. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  280.  
  281. <A NAME="constructor_detail"><!-- --></A>
  282. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  283. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  284. <TD COLSPAN=1><FONT SIZE="+2">
  285. <B>Constructor Detail</B></FONT></TD>
  286. </TR>
  287. </TABLE>
  288.  
  289. <A NAME="Mapping()"><!-- --></A><H3>
  290. Mapping</H3>
  291. <PRE>
  292. public <B>Mapping</B>()</PRE>
  293. <DL>
  294. <DD>Default no-argument constructor.</DL>
  295. <HR>
  296.  
  297. <A NAME="Mapping(java.lang.String)"><!-- --></A><H3>
  298. Mapping</H3>
  299. <PRE>
  300. public <B>Mapping</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  301. <DL>
  302. <DD>Constructor that is passed the mapping name.</DL>
  303.  
  304. <!-- ============ METHOD DETAIL ========== -->
  305.  
  306. <A NAME="method_detail"><!-- --></A>
  307. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  308. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  309. <TD COLSPAN=1><FONT SIZE="+2">
  310. <B>Method Detail</B></FONT></TD>
  311. </TR>
  312. </TABLE>
  313.  
  314. <A NAME="addView(java.lang.String)"><!-- --></A><H3>
  315. addView</H3>
  316. <PRE>
  317. public void <B>addView</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;line)</PRE>
  318. <DL>
  319. <DD><DL>
  320. </DL>
  321. </DD>
  322. </DL>
  323. <HR>
  324.  
  325. <A NAME="addView(java.lang.String, java.lang.String)"><!-- --></A><H3>
  326. addView</H3>
  327. <PRE>
  328. public void <B>addView</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;from,
  329.                     <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;to)</PRE>
  330. <DL>
  331. <DD>Add a view to the Mapping.<DD><DL>
  332. </DL>
  333. </DD>
  334. <DD><DL>
  335. <DT><B>Parameters:</B><DD><CODE>view</CODE> - View for the mapping.</DL>
  336. </DD>
  337. </DL>
  338. <HR>
  339.  
  340. <A NAME="commit()"><!-- --></A><H3>
  341. commit</H3>
  342. <PRE>
  343. public abstract void <B>commit</B>()
  344.                      throws <A HREF="../../../com/perforce/api/CommitException.html">CommitException</A></PRE>
  345. <DL>
  346. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  347. <DD>Stores this object back into Perforce, creating it if it
  348.  didn't already exist.<DD><DL>
  349. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  350. </DD>
  351. </DL>
  352. <HR>
  353.  
  354. <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
  355. compareTo</H3>
  356. <PRE>
  357. public int <B>compareTo</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>&nbsp;o)</PRE>
  358. <DL>
  359. <DD><DL>
  360. <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Comparable.html#compareTo(java.lang.Object)">compareTo</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Comparable.html">Comparable</A></CODE></DL>
  361. </DD>
  362. </DL>
  363. <HR>
  364.  
  365. <A NAME="getDescription()"><!-- --></A><H3>
  366. getDescription</H3>
  367. <PRE>
  368. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getDescription</B>()</PRE>
  369. <DL>
  370. <DD>Returns the Mapping description.<DD><DL>
  371. </DL>
  372. </DD>
  373. </DL>
  374. <HR>
  375.  
  376. <A NAME="getName()"><!-- --></A><H3>
  377. getName</H3>
  378. <PRE>
  379. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
  380. <DL>
  381. <DD>Returns the name of the Mapping.<DD><DL>
  382. </DL>
  383. </DD>
  384. </DL>
  385. <HR>
  386.  
  387. <A NAME="getOwner()"><!-- --></A><H3>
  388. getOwner</H3>
  389. <PRE>
  390. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getOwner</B>()</PRE>
  391. <DL>
  392. <DD>Returns the owner of the Mapping.<DD><DL>
  393. </DL>
  394. </DD>
  395. </DL>
  396. <HR>
  397.  
  398. <A NAME="getView()"><!-- --></A><H3>
  399. getView</H3>
  400. <PRE>
  401. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getView</B>()</PRE>
  402. <DL>
  403. <DD><DL>
  404. </DL>
  405. </DD>
  406. <DD><DL>
  407. <DT><B>Returns:</B><DD>String version of all the views in this mapping.</DL>
  408. </DD>
  409. </DL>
  410. <HR>
  411.  
  412. <A NAME="getViews()"><!-- --></A><H3>
  413. getViews</H3>
  414. <PRE>
  415. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>getViews</B>()</PRE>
  416. <DL>
  417. <DD><DL>
  418. </DL>
  419. </DD>
  420. <DD><DL>
  421. <DT><B>Returns:</B><DD>Enumerated list of the views in this mapping.</DL>
  422. </DD>
  423. </DL>
  424. <HR>
  425.  
  426. <A NAME="lookupMappings(com.perforce.api.HashDecay, java.lang.String)"><!-- --></A><H3>
  427. lookupMappings</H3>
  428. <PRE>
  429. public static <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Enumeration.html">Enumeration</A> <B>lookupMappings</B>(<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A>&nbsp;mappings,
  430.                                          <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;prefix)</PRE>
  431. <DL>
  432. <DD>Returns a list of mappings that begin with the specified prefix.<DD><DL>
  433. </DL>
  434. </DD>
  435. <DD><DL>
  436. <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - Prefix for all mappings to be returned<DT><B>Returns:</B><DD>List of mappings matching the prefix.</DL>
  437. </DD>
  438. </DL>
  439. <HR>
  440.  
  441. <A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
  442. setDescription</H3>
  443. <PRE>
  444. public void <B>setDescription</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;description)</PRE>
  445. <DL>
  446. <DD>Sets the description for the Mapping.<DD><DL>
  447. </DL>
  448. </DD>
  449. <DD><DL>
  450. <DT><B>Parameters:</B><DD><CODE>description</CODE> - Description of the mapping.</DL>
  451. </DD>
  452. </DL>
  453. <HR>
  454.  
  455. <A NAME="setName(java.lang.String)"><!-- --></A><H3>
  456. setName</H3>
  457. <PRE>
  458. public void <B>setName</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  459. <DL>
  460. <DD>Sets the name of the Mapping.<DD><DL>
  461. </DL>
  462. </DD>
  463. <DD><DL>
  464. <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the mapping.</DL>
  465. </DD>
  466. </DL>
  467. <HR>
  468.  
  469. <A NAME="setOwner(java.lang.String)"><!-- --></A><H3>
  470. setOwner</H3>
  471. <PRE>
  472. public void <B>setOwner</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;owner)</PRE>
  473. <DL>
  474. <DD>Sets the owner of the Mapping.<DD><DL>
  475. </DL>
  476. </DD>
  477. <DD><DL>
  478. <DT><B>Parameters:</B><DD><CODE>owner</CODE> - Owner of the mapping.</DL>
  479. </DD>
  480. </DL>
  481. <HR>
  482.  
  483. <A NAME="sync(java.lang.String)"><!-- --></A><H3>
  484. sync</H3>
  485. <PRE>
  486. public abstract void <B>sync</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
  487. <DL>
  488. <DD>Synchronizes the Mapping with the latest information from P4. This method
  489.  forces the Mapping to contain the latest, correct information if it didn't
  490.  already.<DD><DL>
  491. </DL>
  492. </DD>
  493. <DD><DL>
  494. <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the Mapping to synchronize.</DL>
  495. </DD>
  496. </DL>
  497. <HR>
  498.  
  499. <A NAME="toString()"><!-- --></A><H3>
  500. toString</H3>
  501. <PRE>
  502. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
  503. <DL>
  504. <DD><DL>
  505. <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>
  506. </DD>
  507. <DD><DL>
  508. <DT><B>Returns:</B><DD>Name of the mapping.</DL>
  509. </DD>
  510. </DL>
  511. <HR>
  512.  
  513. <A NAME="toXML()"><!-- --></A><H3>
  514. toXML</H3>
  515. <PRE>
  516. public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
  517. <DL>
  518. <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
  519. <DD>Returns a string containing the object in XML form.<DD><DL>
  520. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
  521. </DD>
  522. </DL>
  523. <!-- ========= END OF CLASS DATA ========= -->
  524. <HR>
  525.  
  526. <!-- ========== START OF NAVBAR ========== -->
  527. <A NAME="navbar_bottom"><!-- --></A>
  528. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  529. <TR>
  530. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  531. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  532. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  533.   <TR ALIGN="center" VALIGN="top">
  534.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  535.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  536.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Mapping.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  537.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  538.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  539.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  540.   </TR>
  541. </TABLE>
  542. </TD>
  543. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  544. <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>
  545. </TD>
  546. </TR>
  547.  
  548. <TR>
  549. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  550. &nbsp;<A HREF="../../../com/perforce/api/Label.html"><B>PREV CLASS</B></A>&nbsp;
  551. &nbsp;<A HREF="../../../com/perforce/api/P4JNI.html"><B>NEXT CLASS</B></A></FONT></TD>
  552. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  553.   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  554. &nbsp;<A HREF="Mapping.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  555. </TR>
  556. <TR>
  557. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  558.   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  559. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  560. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  561. </TR>
  562. </TABLE>
  563. <!-- =========== END OF NAVBAR =========== -->
  564.  
  565. <HR>
  566. <i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
  567. </BODY>
  568. </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