Helix SwarmHelix Swarm
Loading...

P4Spec.html

  • //
  • guest/
  • tony_smith/
  • perforce/
  • API/
  • Ruby/
  • main/
  • doc/
  • P4Spec.html #1
  • View
  • Commits
  • Open Download .zip Download (4 KB) 
  1. <html>
  2. <head>
  3.   <title>P4/Ruby - P4::Spec</title>
  4.   <link rel="stylesheet" type="text/css" href="docstyle.css">
  5. </head>
  6. <body>
  7.   <p align="right">
  8.     <a href="index.html">Contents</a>
  9.   </p>
  10.  
  11.   <div class="classhdr">
  12.     <table border=0>
  13.       <tr>
  14. 	<td>
  15. 	  <span class="classtag">Class</span>
  16. 	  <span class="classname">P4::Spec</span>
  17. 	  <span class="classparent">&lt; Hash</span>
  18. 	</td>
  19. 	<td id="righttext">
  20. 	  <span class="requiretag">require</span>
  21. 	  <span class="modulename">"P4"</span>
  22. 	</td>
  23.       </tr>
  24.     </table>
  25.   </div>
  26.   <div class="classhdr">
  27.   </div>
  28.  
  29.   <h3>Description</h3>
  30.  
  31.   The P4::Spec class is a hash containing key/value pairs for all the
  32.   fields in a Perforce form. It provides two things over and above its
  33.   parent class (Hash):
  34.  
  35.   <ul>
  36.     <li>
  37.       Fieldname validation. Only valid field names may be set in a 
  38.       P4::Spec object. Note that only the field name is validated, not
  39.       the content.
  40.     </li>
  41.     <li>
  42.       Accessor methods for easy access to the fields
  43.     </li>
  44.   </ul>
  45.  
  46.  
  47.   <div class="classmethods">
  48.     <h3>Class Methods</h3>
  49.  
  50.  
  51.     <div class="index">
  52.       <table border="0">
  53. 	<tr>
  54. 	  <td>
  55. 	    <a href="#new">new</a>
  56. 	  </td>
  57. 	</tr>
  58.       </table>
  59.     </div>
  60.  
  61.  
  62.     <a name="new"></a>
  63.     <div class="method">
  64.       <div class="methodheader">
  65. 	<table width="100%">
  66. 	  <tr>
  67. 	    <td class="meth_name">new</td>
  68. 	    <td>&nbsp;</td>
  69. 	    <td class="proto">
  70. 	      P4::Spec.new( <i>anArray</i> ) -&gt; <i>aP4::Spec</i>
  71. 	    </td>
  72. 	  </tr>
  73. 	</table>
  74.       </div>
  75.  
  76.       Constructs a new P4::Spec object given an array of valid fieldnames.
  77.  
  78.     </div>
  79.   </div>
  80.  
  81.   <div class="instancemethods">
  82.  
  83.     <h3>Instance Methods</h3>
  84.  
  85.     <div class="index">
  86.       <table border="0">
  87. 	<tr>
  88. 	  <td>
  89. 	    <a href="#getters">_&lt;fieldname&gt;</a>
  90. 	  </td>
  91. 	  <td>
  92. 	    <a href="#setters">_&lt;fieldname&gt;=</a>
  93. 	  </td>
  94. 	  <td>
  95. 	    <a href="#permitted_fields">permitted_fields</a>
  96. 	  </td>
  97. 	</tr>
  98.       </table>
  99.     </div>
  100.  
  101.  
  102.     <a name="getters"></a>
  103.     <div class="method">
  104.       <div class="methodheader">
  105. 	<table width="100%">
  106. 	  <tr>
  107. 	    <td class="meth_name">_&lt;fieldname&gt;</td>
  108. 	    <td>&nbsp;</td>
  109. 	    <td class="proto">
  110. 	      <i>spec</i>._&lt;fieldname&gt; -&gt; <i>aValue</i>
  111. 	    </td>
  112. 	  </tr>
  113. 	</table>
  114.       </div>
  115.  
  116.       Returns the value associated with the field named &lt;fieldname&gt;.
  117.       This is equivalent to 
  118.       <span class="inlinecode">spec[ "&lt;fieldname&gt;" ]</span> with the
  119.       exception that when used as a method, the fieldnames may be in 
  120.       lowercase regardless of the actual case of the fieldname.
  121.  
  122.       <pre>
  123.     client = p4.fetch_client()
  124.     root   = client._root
  125.     desc   = client._description
  126.       </pre>
  127.     </div>
  128.  
  129.     <a name="setters"></a>
  130.     <div class="method">
  131.       <div class="methodheader">
  132. 	<table width="100%">
  133. 	  <tr>
  134. 	    <td class="meth_name">_&lt;fieldname&gt;=</td>
  135. 	    <td>&nbsp;</td>
  136. 	    <td class="proto">
  137. 	      <i>spec</i>._&lt;fieldname&gt;= aValue -&gt; <i>aValue</i>
  138. 	    </td>
  139. 	  </tr>
  140. 	</table>
  141.       </div>
  142.  
  143.       Updates the value of the named field in the spec. Raises a P4Exception
  144.       if the fieldname is not valid for specs of this type.
  145.  
  146.       <pre>
  147.     client = p4.fetch_client()
  148.  
  149.     client._root         = "/home/tony/new-client"
  150.     client._description  = "My new client spec"
  151.  
  152.     p4.save_client( client )
  153.       </pre>
  154.     </div>
  155.  
  156.     <a name="permitted_fields"></a>
  157.     <div class="method">
  158.       <div class="methodheader">
  159. 	<table width="100%">
  160. 	  <tr>
  161. 	    <td class="meth_name">permitted_fields</td>
  162. 	    <td>&nbsp;</td>
  163. 	    <td class="proto">
  164. 	      <i>spec</i>.permitted_fields -&gt; <i>anArray</i>
  165. 	    </td>
  166. 	  </tr>
  167. 	</table>
  168.       </div>
  169.  
  170.       Returns an array containing the names of fields that are valid in 
  171.       this spec object. This does not imply that values for all of these 
  172.       fields are actually set in this object, merely that you may choose to 
  173.       set values for any of these fields if you wish to.
  174.     </div>
  175.  
  176.   <div class="seealso">
  177.     <h3>See Also</h3>
  178.  
  179.     <a href="P4.html">P4</a>
  180.     <a href="P4Exception.html">P4Exception</a>
  181.     <a href="P4DepotFile.html">P4DepotFile</a>
  182.     <a href="P4Integration.html">P4Integration</a>
  183.     <a href="P4Revision.html">P4Revision</a>
  184.   </div>
  185.  
  186. </body>
  187. </html>
# Change User Description Committed
#1 4680 Tony Smith Make P4Ruby return new P4::Spec objects instead of plain old
hashes when parse_forms mode... is in use. A P4::Spec object is derived
from Hash so should be backwards compatible with previous code.

P4::Spec provides limited fieldname validation on forms and
accessor methods for quick and easy access to the fields in the
form. The accessor methods are all prefixed with '_' to avoid
colliding with methods from the Hash parent class. This is a little
ugly, but deriving from hash is a big win, so it's worth it.

This change also fixes a minor bug found along the way. Spec parsing
and formatting wouldn't work with labels, branches, depots and groups
unless you'd previously run a P4::fetch_label( <label> ),
P4::fetch_branch( <branch> ) etc. etc. This is because the spec
parsing code internally runs one of these commands in order to grab
the specdef from the server but it wasn't providing a spec name. i.e.
it was using 'p4 client -o' and assuming that this would work for
other types of spec too. It does, but not for all spec types. So,
now the spec parsing code will use a bogus name for the spec types
that require it. «		 20 years ago
//guest/tony_smith/perforce/API/Ruby/main/doc/P4Revision.html
#5 4653 Tony Smith More documentation tweaks.
Just makes the pages look more
like the reference pages in the... 'Pickaxe book' «		 20 years ago
#4 4652 Tony Smith Doc update for P4Ruby.
Rework the html and the CSS to make the
docs a little easier on t...he eye and easier to use too. «		 20 years ago
#3 4255 Tony Smith P4Ruby doc reformatting.
Now uses CSS instead of 1x1 image and too
many tables. Could no... doubt be improved upon, but it's a start. «		 21 years ago
#2 2426 Tony Smith Doc beautifying for P4Ruby. 22 years ago
#1 2392 Tony Smith Add missing documentation file 22 years ago