<html>
<head>
<title>P4/Ruby - P4DepotFile</title>
<link rel="stylesheet" type="text/css" href="docstyle.css">
</head>
<body>
<p align="right">
<a href="index.html">Contents</a>
</p>
<div class="classhdr">
</div>
<div class="classhdr">
<table border=0>
<tr>
<td>
<span class="classtag">Class</span>
<span class="classname">P4DepotFile</span>
<span class="classparent">< Object</span>
</td>
<td id="righttext">
<span class="requiretag">require</span>
<span class="modulename">"P4"</span>
</td>
</tr>
</table>
</div>
<h3>Description</h3>
Utility class providing easy access to the attributes of a file in a
Perforce depot. Currently only P4#run_filelog returns an array of
P4DepotFile objects. Each P4DepotFile object contains summary information
about the file, and a list of revisions (P4Revision objects) of that file.
<div class="classmethods">
<h3>Class Methods</h3>
<a name="#new"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">new</td>
<td> </td>
<td class="proto">
P4DepotFile.new( <i>aString</i> ) -> <i>aP4DepotFile</i>
</td>
</tr>
</table>
</div>
Constructs a new P4DepotFile object for the named depot file.
</div>
</div>
<div class="instancemethods">
<h3>Instance Methods</h3>
<a name="#depot_file"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">depot_file</td>
<td> </td>
<td class="proto">
<i>df</i>.depot_file -> <i>aString</i>
</td>
</tr>
</table>
</div>
Returns the name of the depot file this object refers to.
</div>
<a name="#each_revision"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">each_revision</td>
<td> </td>
<td class="proto">
<i>df</i>.each_revision { |<i>rev</i>| block } -> <i>revArray</i>
</td>
</tr>
</table>
</div>
Iterates over each revision of the depot file
</div>
<a name="#head_action"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_action</td>
<td> </td>
<td class="proto">
<i>df</i>.head_action -> <i>aString</i>
</td>
</tr>
</table>
</div>
Returns the name of the action that gave rise to the head revision.
</div>
<a name="#head_action-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_action=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_action = <i>aString</i> -> <i>aString</i>
</td>
</tr>
</table>
</div>
Set the name of the action that gave rise to the head revision.
</div>
<a name="#head_change"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_change</td>
<td> </td>
<td class="proto">
<i>df</i>.head_change -> <i>aNumber</i>
</td>
</tr>
</table>
</div>
Get the number of the change that gave rise to the head revision.
</div>
<a name="#head_change-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_change=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_change = <i>aNumber</i> -> <i>aNumber</i>
</td>
</tr>
</table>
</div>
Set the number of the change that gave rise to the head revision.
</div>
<a name="#head_rev"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_rev</td>
<td> </td>
<td class="proto">
<i>df</i>.head_rev -> <i>aNumber</i>
</td>
</tr>
</table>
</div>
Returns the revision number of the head revision.
</div>
<a name="#head_rev-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_rev=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_rev = <i>aNumber</i> -> <i>aNumber</i>
</td>
</td>
</tr>
</table>
</div>
Set the number of the head revision.
</div>
<a name="#head_time"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_time</td>
<td> </td>
<td class="proto">
<i>df</i>.head_time -> <i>aTime</i>
</td>
</tr>
</table>
</div>
Returns the time that the head revision was created.
</div>
<a name="#head_time-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_time=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_time = <i>aTime</i> -> <i>aTime</i>
</td>
</tr>
</table>
</div>
Set the time that the head revision was created.
</div>
<a name="#head_type"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_type</td>
<td> </td>
<td class="proto">
<i>df</i>.head_type -> <i>aString</i>
</td>
</tr>
</table>
</div>
Returns the Perforce type of the head revision.
</div>
<a name="#head_type-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_type=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_type = <i>aString</i> -> <i>aString</i>
</td>
</tr>
</table>
</div>
Sets the type of the head revision.
</div>
<a name="#new_revision"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">new_revision</td>
<td> </td>
<td class="proto">
<i>df</i>.new_revision -> <i>aP4Revision</i>
</td>
</tr>
</table>
</div>
Creates a new (empty) P4Revision object and adds it to the list of
revisions of the depot file. Returns the newly created P4Revision object
so that you can populate it.
</div>
<a name="#revisions"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">revisions</td>
<td> </td>
<td class="proto">
<i>df</i>.revisions -> <i>aArray</i>
</td>
</tr>
</table>
</div>
Returns an array of revisions of the depot file
</div>
</div>
<h3>See Also</h3>
<div class="seealso">
<a href="P4.html">P4</a>
<a href="P4Exception.html">P4Exception</a>
<a href="P4Integration.html">P4Integration</a>
<a href="P4Revision.html">P4Revision</a>
<a href="P4Spec.html">P4::Spec</a>
</div>
</body>
</html>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #2 | 14520 | tony |
Replace old P4Ruby documentation with a RELNOTES file, (and ultimately, Doug's new manual), and update the MANIFEST to match (and include the new tests) I've also removed the old installer files as our new installer won't use them. |
||
| #1 | 14480 | tony |
Add P4Ruby 1.5944 to main as start-point for the first productized release of P4Ruby |