syntax fix
[openafs-wiki.git] / JavaAdminAPI / Partition.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:37 PDT 2003 -->
6 <TITLE>
7 Partition (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Partition,Partition class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="Partition (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27   <TR ALIGN="center" VALIGN="top">
28   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Partition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;<A HREF="../../../org/openafs/jafs/Key.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;<A HREF="../../../org/openafs/jafs/Process.html"><B>NEXT CLASS</B></A></FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49 &nbsp;<A HREF="Partition.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class Partition</H2>
79 <PRE>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
81   |
82   +--<B>org.openafs.jafs.Partition</B>
83 </PRE>
84 <DL>
85 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A></DD>
86 </DL>
87 <HR>
88 <DL>
89 <DT>public class <B>Partition</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></DL>
90
91 <P>
92 An abstract representation of an AFS partition.  It holds information about 
93  the partition, such as what its total space is.
94  <BR><BR>
95
96  Constructing an instance of a <code>Partition</code> does not mean 
97  an actual AFS partition is created on a server -- on the contrary, 
98  a <code>Partition</code> object must be a representation of an already 
99  existing AFS partition.  There is no way to create a new AFS partition 
100  through this API.<BR><BR>
101
102  Each <code>Partition</code> object has its own individual set of
103  <code>Volume</code>s. This represents the properties and attributes 
104  of an actual AFS cell.<BR><BR>
105
106  <!--Example of how to use class-->
107  The following is a simple example of how to obtain and use a 
108  <code>Partition</code> object.  In this example, a list of the 
109  <code>Partition</code> objects of a server are obtained, and the name
110  and number of volumes is printed out for each one.<BR><BR>
111  
112  <PRE>
113  import org.openafs.jafs.Cell;
114  import org.openafs.jafs.AFSException;
115  import org.openafs.jafs.Partition;
116  import org.openafs.jafs.Server;
117  ...
118  public class ...
119  {
120    ...
121    private Cell cell;
122    private Server server;
123    ...
124    public static void main(String[] args) throws Exception
125    {
126      String username   = arg[0];
127      String password   = arg[1];
128      String cellName   = arg[2];
129      String serverName = arg[3];
130  
131      token = new Token(username, password, cellName);
132      cell   = new Cell(token);
133      server = new Server(serverName, cell);
134  
135      System.out.println("Partitions in Server " + server.getName() + ":");
136      Partition[] partitions = server.getPartitions();
137      for (int i = 0; i < partitions.length; i++) {
138        System.out.print("Partition " + partitions[i].getName());
139        System.out.print("hosts " + partitions[i].getVolumeCount());
140        System.out.print("volumes.\n");
141      }
142    }
143    ...
144  }
145  </PRE>
146 <P>
147
148 <P>
149 <DL>
150 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Partition">Serialized Form</A></DL>
151 <HR>
152
153 <P>
154 <!-- ======== NESTED CLASS SUMMARY ======== -->
155
156
157 <!-- =========== FIELD SUMMARY =========== -->
158
159 <A NAME="field_summary"><!-- --></A>
160 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
161 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162 <TD COLSPAN=2><FONT SIZE="+2">
163 <B>Field Summary</B></FONT></TD>
164 </TR>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
168 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#cachedInfo">cachedInfo</A></B></CODE>
169
170 <BR>
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
172 </TR>
173 <TR BGCOLOR="white" CLASS="TableRowColor">
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175 <CODE>protected &nbsp;<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A></CODE></FONT></TD>
176 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#cell">cell</A></B></CODE>
177
178 <BR>
179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
180 </TR>
181 <TR BGCOLOR="white" CLASS="TableRowColor">
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
184 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#deviceName">deviceName</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>protected &nbsp;int</CODE></FONT></TD>
192 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#id">id</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>protected &nbsp;int</CODE></FONT></TD>
200 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#lockFileDescriptor">lockFileDescriptor</A></B></CODE>
201
202 <BR>
203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
204 </TR>
205 <TR BGCOLOR="white" CLASS="TableRowColor">
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
208 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#name">name</A></B></CODE>
209
210 <BR>
211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
212 </TR>
213 <TR BGCOLOR="white" CLASS="TableRowColor">
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215 <CODE>protected &nbsp;<A HREF="../../../org/openafs/jafs/Server.html">Server</A></CODE></FONT></TD>
216 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#server">server</A></B></CODE>
217
218 <BR>
219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
220 </TR>
221 <TR BGCOLOR="white" CLASS="TableRowColor">
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223 <CODE>protected &nbsp;int</CODE></FONT></TD>
224 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#totalFreeSpace">totalFreeSpace</A></B></CODE>
225
226 <BR>
227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
228 </TR>
229 <TR BGCOLOR="white" CLASS="TableRowColor">
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231 <CODE>protected &nbsp;int</CODE></FONT></TD>
232 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#totalQuota">totalQuota</A></B></CODE>
233
234 <BR>
235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
236 </TR>
237 <TR BGCOLOR="white" CLASS="TableRowColor">
238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239 <CODE>protected &nbsp;int</CODE></FONT></TD>
240 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#totalSpace">totalSpace</A></B></CODE>
241
242 <BR>
243 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
244 </TR>
245 <TR BGCOLOR="white" CLASS="TableRowColor">
246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
248 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#volumeNames">volumeNames</A></B></CODE>
249
250 <BR>
251 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
252 </TR>
253 <TR BGCOLOR="white" CLASS="TableRowColor">
254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
256 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#volumes">volumes</A></B></CODE>
257
258 <BR>
259 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
260 </TR>
261 </TABLE>
262 &nbsp;
263 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
264
265 <A NAME="constructor_summary"><!-- --></A>
266 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
267 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
268 <TD COLSPAN=2><FONT SIZE="+2">
269 <B>Constructor Summary</B></FONT></TD>
270 </TR>
271 <TR BGCOLOR="white" CLASS="TableRowColor">
272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273 <CODE>(package private)</CODE></FONT></TD>
274 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#Partition(org.openafs.jafs.Server)">Partition</A></B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)</CODE>
275
276 <BR>
277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a blank <code>Server</code> given the cell to which the partition
278  belongs and the server on which the partition resides.  </TD>
279 </TR>
280 <TR BGCOLOR="white" CLASS="TableRowColor">
281 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282 <CODE>&nbsp;</CODE></FONT></TD>
283 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#Partition(java.lang.String, org.openafs.jafs.Server)">Partition</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
284           <A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)</CODE>
285
286 <BR>
287 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <code>Partition</code> object instance given the 
288  name of the AFS partition and the AFS server, represented by 
289  <CODE>server</CODE>, to which it belongs.   </TD>
290 </TR>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE>&nbsp;</CODE></FONT></TD>
294 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#Partition(java.lang.String, org.openafs.jafs.Server, boolean)">Partition</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
295           <A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server,
296           boolean&nbsp;preloadAllMembers)</CODE>
297
298 <BR>
299 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <CODE>Partition</CODE> object instance given the name 
300  of the AFS partition and the AFS server, represented by 
301  <CODE>server</CODE>, to which it belongs.   </TD>
302 </TR>
303 </TABLE>
304 &nbsp;
305 <!-- ========== METHOD SUMMARY =========== -->
306
307 <A NAME="method_summary"><!-- --></A>
308 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
309 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
310 <TD COLSPAN=2><FONT SIZE="+2">
311 <B>Method Summary</B></FONT></TD>
312 </TR>
313 <TR BGCOLOR="white" CLASS="TableRowColor">
314 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315 <CODE>&nbsp;int</CODE></FONT></TD>
316 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</CODE>
317
318 <BR>
319 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comparable interface method.</TD>
320 </TR>
321 <TR BGCOLOR="white" CLASS="TableRowColor">
322 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323 <CODE>&nbsp;int</CODE></FONT></TD>
324 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#compareTo(org.openafs.jafs.Partition)">compareTo</A></B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition)</CODE>
325
326 <BR>
327 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two Partition objects respective to their names and does not
328  factor any other attribute.    </TD>
329 </TR>
330 <TR BGCOLOR="white" CLASS="TableRowColor">
331 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332 <CODE>&nbsp;boolean</CODE></FONT></TD>
333 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#equals(org.openafs.jafs.Partition)">equals</A></B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;otherPartition)</CODE>
334
335 <BR>
336 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether two <code>Partition</code> objects are equal, 
337  based on their names and hosting server.</TD>
338 </TR>
339 <TR BGCOLOR="white" CLASS="TableRowColor">
340 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
342 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getDeviceName()">getDeviceName</A></B>()</CODE>
343
344 <BR>
345 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the device name of this partition (i.e. </TD>
346 </TR>
347 <TR BGCOLOR="white" CLASS="TableRowColor">
348 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349 <CODE>&nbsp;int</CODE></FONT></TD>
350 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getID()">getID</A></B>()</CODE>
351
352 <BR>
353 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the id of this partition (i.e. </TD>
354 </TR>
355 <TR BGCOLOR="white" CLASS="TableRowColor">
356 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
357 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
358 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getInfo()">getInfo</A></B>()</CODE>
359
360 <BR>
361 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> representation of this 
362  <code>Partition</code>.  </TD>
363 </TR>
364 <TR BGCOLOR="white" CLASS="TableRowColor">
365 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
366 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
367 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getInfoVolumes()">getInfoVolumes</A></B>()</CODE>
368
369 <BR>
370 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> containing the <code>String</code> 
371  representations of all the volumes of this <code>Partition</code>.</TD>
372 </TR>
373 <TR BGCOLOR="white" CLASS="TableRowColor">
374 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375 <CODE>&nbsp;int</CODE></FONT></TD>
376 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getLockFileDescriptor()">getLockFileDescriptor</A></B>()</CODE>
377
378 <BR>
379 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the lock file descriptor of this partition</TD>
380 </TR>
381 <TR BGCOLOR="white" CLASS="TableRowColor">
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
384 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getName()">getName</A></B>()</CODE>
385
386 <BR>
387 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this partition.</TD>
388 </TR>
389 <TR BGCOLOR="white" CLASS="TableRowColor">
390 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
391 <CODE>protected static&nbsp;void</CODE></FONT></TD>
392 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getPartitionInfo(int, int, int, org.openafs.jafs.Partition)">getPartitionInfo</A></B>(int&nbsp;cellHandle,
393                  int&nbsp;serverHandle,
394                  int&nbsp;partition,
395                  <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;thePartition)</CODE>
396
397 <BR>
398 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills in the information fields of the provided <code>Partition</code>.</TD>
399 </TR>
400 <TR BGCOLOR="white" CLASS="TableRowColor">
401 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Server.html">Server</A></CODE></FONT></TD>
403 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getServer()">getServer</A></B>()</CODE>
404
405 <BR>
406 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this partition's hosting server.</TD>
407 </TR>
408 <TR BGCOLOR="white" CLASS="TableRowColor">
409 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410 <CODE>&nbsp;int</CODE></FONT></TD>
411 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalFreeSpace()">getTotalFreeSpace</A></B>()</CODE>
412
413 <BR>
414 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total free space on this partition.
415  </TD>
416 </TR>
417 <TR BGCOLOR="white" CLASS="TableRowColor">
418 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419 <CODE>&nbsp;int</CODE></FONT></TD>
420 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota()">getTotalQuota</A></B>()</CODE>
421
422 <BR>
423 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total combined quota of all volumes on this partition,
424  unless a volume has configured an unlimited quota at which case an
425  <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> is thrown.
426
427  </TD>
428 </TR>
429 <TR BGCOLOR="white" CLASS="TableRowColor">
430 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
431 <CODE>&nbsp;int</CODE></FONT></TD>
432 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota(boolean)">getTotalQuota</A></B>(boolean&nbsp;ignoreUnlimitedQuotas)</CODE>
433
434 <BR>
435 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total combined quota of all volumes on this partition,
436  ignoring volumes with unlimited quotas, if <CODE>
437  ignoreUnlimitedQuotas</CODE> is <CODE>true</CODE>; otherwise an
438  <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> is thrown if a volume has an unlimited quota.
439
440  </TD>
441 </TR>
442 <TR BGCOLOR="white" CLASS="TableRowColor">
443 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
444 <CODE>&nbsp;int</CODE></FONT></TD>
445 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalSpace()">getTotalSpace</A></B>()</CODE>
446
447 <BR>
448 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total space on this partition.</TD>
449 </TR>
450 <TR BGCOLOR="white" CLASS="TableRowColor">
451 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
452 <CODE>&nbsp;int</CODE></FONT></TD>
453 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getUsedSpace()">getUsedSpace</A></B>()</CODE>
454
455 <BR>
456 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total used space on this partition.
457  </TD>
458 </TR>
459 <TR BGCOLOR="white" CLASS="TableRowColor">
460 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
461 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A></CODE></FONT></TD>
462 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolume(java.lang.String)">getVolume</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
463
464 <BR>
465 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the <CODE>Volume</CODE> object (which is an abstract 
466  representation of an actual AFS volume of this partition) designated 
467  by <code>name</code> (i.e. </TD>
468 </TR>
469 <TR BGCOLOR="white" CLASS="TableRowColor">
470 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
471 <CODE>&nbsp;int</CODE></FONT></TD>
472 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount()">getVolumeCount</A></B>()</CODE>
473
474 <BR>
475 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of volumes contained in this partition.
476
477  </TD>
478 </TR>
479 <TR BGCOLOR="white" CLASS="TableRowColor">
480 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
481 <CODE>protected static&nbsp;int</CODE></FONT></TD>
482 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount(int, int, int)">getVolumeCount</A></B>(int&nbsp;cellHandle,
483                int&nbsp;serverHandle,
484                int&nbsp;partition)</CODE>
485
486 <BR>
487 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of volumes hosted by this partition.</TD>
488 </TR>
489 <TR BGCOLOR="white" CLASS="TableRowColor">
490 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
491 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
492 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeNames()">getVolumeNames</A></B>()</CODE>
493
494 <BR>
495 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves an array containing all of the names of volumes
496  associated with this <code>Partition</code>. 
497  </TD>
498 </TR>
499 <TR BGCOLOR="white" CLASS="TableRowColor">
500 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
501 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
502 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeNames(int, int)">getVolumeNames</A></B>(int&nbsp;startIndex,
503                int&nbsp;length)</CODE>
504
505 <BR>
506 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing a subset of the names of volumes
507  associated with this <code>Partition</code>.  </TD>
508 </TR>
509 <TR BGCOLOR="white" CLASS="TableRowColor">
510 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
511 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>[]</CODE></FONT></TD>
512 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumes()">getVolumes</A></B>()</CODE>
513
514 <BR>
515 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves an array containing all of the <code>Volume</code> objects 
516  associated with this <code>Partition</code>, each of which is an 
517  abstract representation of an actual AFS volume of the AFS partition.
518  </TD>
519 </TR>
520 <TR BGCOLOR="white" CLASS="TableRowColor">
521 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
522 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>[]</CODE></FONT></TD>
523 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumes(int, int)">getVolumes</A></B>(int&nbsp;startIndex,
524            int&nbsp;length)</CODE>
525
526 <BR>
527 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing a subset of the <code>Volume</code> objects
528  associated with this <code>Partition</code>, each of which is an abstract
529  representation of an actual AFS volume of the AFS partition.  </TD>
530 </TR>
531 <TR BGCOLOR="white" CLASS="TableRowColor">
532 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
533 <CODE>protected static&nbsp;int</CODE></FONT></TD>
534 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesAdvanceTo(int, org.openafs.jafs.Volume, int)">getVolumesAdvanceTo</A></B>(int&nbsp;iterationId,
535                     <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;theVolume,
536                     int&nbsp;advanceCount)</CODE>
537
538 <BR>
539 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills the next volume object of the partition.  </TD>
540 </TR>
541 <TR BGCOLOR="white" CLASS="TableRowColor">
542 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
543 <CODE>protected static&nbsp;int</CODE></FONT></TD>
544 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBegin(int, int, int)">getVolumesBegin</A></B>(int&nbsp;cellHandle,
545                 int&nbsp;serverHandle,
546                 int&nbsp;partition)</CODE>
547
548 <BR>
549 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin the process of getting the volumes on a partition.  </TD>
550 </TR>
551 <TR BGCOLOR="white" CLASS="TableRowColor">
552 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
553 <CODE>protected static&nbsp;int</CODE></FONT></TD>
554 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBeginAt(int, int, int, int)">getVolumesBeginAt</A></B>(int&nbsp;cellHandle,
555                   int&nbsp;serverHandle,
556                   int&nbsp;partition,
557                   int&nbsp;index)</CODE>
558
559 <BR>
560 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin the process of getting the volumes on a partition.  </TD>
561 </TR>
562 <TR BGCOLOR="white" CLASS="TableRowColor">
563 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
564 <CODE>protected static&nbsp;void</CODE></FONT></TD>
565 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesDone(int)">getVolumesDone</A></B>(int&nbsp;iterationId)</CODE>
566
567 <BR>
568 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that the iteration is complete and will not be accessed anymore.</TD>
569 </TR>
570 <TR BGCOLOR="white" CLASS="TableRowColor">
571 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
572 <CODE>protected static&nbsp;int</CODE></FONT></TD>
573 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesNext(int, org.openafs.jafs.Volume)">getVolumesNext</A></B>(int&nbsp;iterationId,
574                <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;theVolume)</CODE>
575
576 <BR>
577 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills the next volume object of the partition.  </TD>
578 </TR>
579 <TR BGCOLOR="white" CLASS="TableRowColor">
580 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
581 <CODE>protected static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
582 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesNextString(int)">getVolumesNextString</A></B>(int&nbsp;iterationId)</CODE>
583
584 <BR>
585 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next volume of the partition.  </TD>
586 </TR>
587 <TR BGCOLOR="white" CLASS="TableRowColor">
588 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
589 <CODE>&nbsp;boolean</CODE></FONT></TD>
590 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#hasVolumeWithUnlimitedQuota()">hasVolumeWithUnlimitedQuota</A></B>()</CODE>
591
592 <BR>
593 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether this partition contains a volume that has an unlimited
594  quota configured.</TD>
595 </TR>
596 <TR BGCOLOR="white" CLASS="TableRowColor">
597 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
598 <CODE>protected static&nbsp;void</CODE></FONT></TD>
599 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#reclaimPartitionMemory()">reclaimPartitionMemory</A></B>()</CODE>
600
601 <BR>
602 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reclaims all memory being saved by the partition portion of the native 
603  library. </TD>
604 </TR>
605 <TR BGCOLOR="white" CLASS="TableRowColor">
606 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
607 <CODE>&nbsp;void</CODE></FONT></TD>
608 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refresh()">refresh</A></B>()</CODE>
609
610 <BR>
611 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the properties of this Partition object instance with values 
612  from the AFS partition
613  it represents.  </TD>
614 </TR>
615 <TR BGCOLOR="white" CLASS="TableRowColor">
616 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
617 <CODE>protected &nbsp;void</CODE></FONT></TD>
618 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refresh(boolean)">refresh</A></B>(boolean&nbsp;all)</CODE>
619
620 <BR>
621 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the properties of this Partition object instance with values 
622  from the AFS partition it represents.  </TD>
623 </TR>
624 <TR BGCOLOR="white" CLASS="TableRowColor">
625 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
626 <CODE>protected &nbsp;void</CODE></FONT></TD>
627 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refreshInfo()">refreshInfo</A></B>()</CODE>
628
629 <BR>
630 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the information fields of this <code>Partition</code> to 
631  reflect the current state of the AFS partition. </TD>
632 </TR>
633 <TR BGCOLOR="white" CLASS="TableRowColor">
634 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
635 <CODE>protected &nbsp;void</CODE></FONT></TD>
636 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refreshVolumeNames()">refreshVolumeNames</A></B>()</CODE>
637
638 <BR>
639 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of volume names of this partition.</TD>
640 </TR>
641 <TR BGCOLOR="white" CLASS="TableRowColor">
642 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
643 <CODE>protected &nbsp;void</CODE></FONT></TD>
644 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refreshVolumes()">refreshVolumes</A></B>()</CODE>
645
646 <BR>
647 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of <code>Volume</code> objects of this 
648  partition.</TD>
649 </TR>
650 <TR BGCOLOR="white" CLASS="TableRowColor">
651 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
652 <CODE>&nbsp;void</CODE></FONT></TD>
653 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#salvage()">salvage</A></B>()</CODE>
654
655 <BR>
656 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Salvages (restores consistency to) this partition. </TD>
657 </TR>
658 <TR BGCOLOR="white" CLASS="TableRowColor">
659 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
660 <CODE>&nbsp;void</CODE></FONT></TD>
661 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#syncPartition()">syncPartition</A></B>()</CODE>
662
663 <BR>
664 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Syncs this partition to the VLDB.</TD>
665 </TR>
666 <TR BGCOLOR="white" CLASS="TableRowColor">
667 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
668 <CODE>&nbsp;void</CODE></FONT></TD>
669 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#syncVLDB()">syncVLDB</A></B>()</CODE>
670
671 <BR>
672 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Syncs the VLDB to this partition.</TD>
673 </TR>
674 <TR BGCOLOR="white" CLASS="TableRowColor">
675 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
676 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
677 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#toString()">toString</A></B>()</CODE>
678
679 <BR>
680 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this <CODE>Partition</CODE></TD>
681 </TR>
682 <TR BGCOLOR="white" CLASS="TableRowColor">
683 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
684 <CODE>protected static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
685 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#translateIDToName(int)">translateIDToName</A></B>(int&nbsp;id)</CODE>
686
687 <BR>
688 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates a partition id into a partition name</TD>
689 </TR>
690 <TR BGCOLOR="white" CLASS="TableRowColor">
691 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
692 <CODE>protected static&nbsp;int</CODE></FONT></TD>
693 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#translateNameToID(java.lang.String)">translateNameToID</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
694
695 <BR>
696 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates a partition name into a partition id</TD>
697 </TR>
698 </TABLE>
699 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
700 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
701 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
702 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></B></TD>
703 </TR>
704 <TR BGCOLOR="white" CLASS="TableRowColor">
705 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
706 </TR>
707 </TABLE>
708 &nbsp;
709 <P>
710
711 <!-- ============ FIELD DETAIL =========== -->
712
713 <A NAME="field_detail"><!-- --></A>
714 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
715 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
716 <TD COLSPAN=1><FONT SIZE="+2">
717 <B>Field Detail</B></FONT></TD>
718 </TR>
719 </TABLE>
720
721 <A NAME="cell"><!-- --></A><H3>
722 cell</H3>
723 <PRE>
724 protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>cell</B></PRE>
725 <DL>
726 <DL>
727 </DL>
728 </DL>
729 <HR>
730
731 <A NAME="server"><!-- --></A><H3>
732 server</H3>
733 <PRE>
734 protected <A HREF="../../../org/openafs/jafs/Server.html">Server</A> <B>server</B></PRE>
735 <DL>
736 <DL>
737 </DL>
738 </DL>
739 <HR>
740
741 <A NAME="name"><!-- --></A><H3>
742 name</H3>
743 <PRE>
744 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
745 <DL>
746 <DL>
747 </DL>
748 </DL>
749 <HR>
750
751 <A NAME="id"><!-- --></A><H3>
752 id</H3>
753 <PRE>
754 protected int <B>id</B></PRE>
755 <DL>
756 <DL>
757 </DL>
758 </DL>
759 <HR>
760
761 <A NAME="deviceName"><!-- --></A><H3>
762 deviceName</H3>
763 <PRE>
764 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>deviceName</B></PRE>
765 <DL>
766 <DL>
767 </DL>
768 </DL>
769 <HR>
770
771 <A NAME="lockFileDescriptor"><!-- --></A><H3>
772 lockFileDescriptor</H3>
773 <PRE>
774 protected int <B>lockFileDescriptor</B></PRE>
775 <DL>
776 <DL>
777 </DL>
778 </DL>
779 <HR>
780
781 <A NAME="totalSpace"><!-- --></A><H3>
782 totalSpace</H3>
783 <PRE>
784 protected int <B>totalSpace</B></PRE>
785 <DL>
786 <DL>
787 </DL>
788 </DL>
789 <HR>
790
791 <A NAME="totalFreeSpace"><!-- --></A><H3>
792 totalFreeSpace</H3>
793 <PRE>
794 protected int <B>totalFreeSpace</B></PRE>
795 <DL>
796 <DL>
797 </DL>
798 </DL>
799 <HR>
800
801 <A NAME="totalQuota"><!-- --></A><H3>
802 totalQuota</H3>
803 <PRE>
804 protected int <B>totalQuota</B></PRE>
805 <DL>
806 <DL>
807 </DL>
808 </DL>
809 <HR>
810
811 <A NAME="volumes"><!-- --></A><H3>
812 volumes</H3>
813 <PRE>
814 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>volumes</B></PRE>
815 <DL>
816 <DL>
817 </DL>
818 </DL>
819 <HR>
820
821 <A NAME="volumeNames"><!-- --></A><H3>
822 volumeNames</H3>
823 <PRE>
824 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>volumeNames</B></PRE>
825 <DL>
826 <DL>
827 </DL>
828 </DL>
829 <HR>
830
831 <A NAME="cachedInfo"><!-- --></A><H3>
832 cachedInfo</H3>
833 <PRE>
834 protected boolean <B>cachedInfo</B></PRE>
835 <DL>
836 <DL>
837 </DL>
838 </DL>
839
840 <!-- ========= CONSTRUCTOR DETAIL ======== -->
841
842 <A NAME="constructor_detail"><!-- --></A>
843 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
844 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
845 <TD COLSPAN=1><FONT SIZE="+2">
846 <B>Constructor Detail</B></FONT></TD>
847 </TR>
848 </TABLE>
849
850 <A NAME="Partition(java.lang.String, org.openafs.jafs.Server)"><!-- --></A><H3>
851 Partition</H3>
852 <PRE>
853 public <B>Partition</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
854                  <A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)
855           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
856 <DL>
857 <DD>Constructs a new <code>Partition</code> object instance given the 
858  name of the AFS partition and the AFS server, represented by 
859  <CODE>server</CODE>, to which it belongs.   This does not actually
860  create a new AFS partition, it just represents an existing one.
861  If <code>name</code> is not an actual AFS partition, exceptions
862  will be thrown during subsequent method invocations on this 
863  object.
864 <P>
865 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the partition to represent<DD><CODE>server</CODE> - the server on which the partition resides
866 <DT><B>Throws:</B>
867 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
868 <HR>
869
870 <A NAME="Partition(java.lang.String, org.openafs.jafs.Server, boolean)"><!-- --></A><H3>
871 Partition</H3>
872 <PRE>
873 public <B>Partition</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
874                  <A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server,
875                  boolean&nbsp;preloadAllMembers)
876           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
877 <DL>
878 <DD>Constructs a new <CODE>Partition</CODE> object instance given the name 
879  of the AFS partition and the AFS server, represented by 
880  <CODE>server</CODE>, to which it belongs.   This does not actually
881  create a new AFS partition, it just represents an existing one.
882  If <code>name</code> is not an actual AFS partition, exceptions
883  will be thrown during subsequent method invocations on this 
884  object.
885
886  <P> This constructor is ideal for point-in-time representation and 
887  transient applications.  It ensures all data member values are set and 
888  available without calling back to the filesystem at the first request 
889  for them.  Use the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> method to address any coherency 
890  concerns.
891 <P>
892 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the partition to represent<DD><CODE>server</CODE> - the server to which the partition belongs.<DD><CODE>preloadAllMembers</CODE> - true will ensure all object members are 
893                            set upon construction;
894                            otherwise members will be set upon access, 
895                            which is the default behavior.
896 <DT><B>Throws:</B>
897 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
898 <HR>
899
900 <A NAME="Partition(org.openafs.jafs.Server)"><!-- --></A><H3>
901 Partition</H3>
902 <PRE>
903 <B>Partition</B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)
904     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
905 <DL>
906 <DD>Creates a blank <code>Server</code> given the cell to which the partition
907  belongs and the server on which the partition resides.  This blank 
908  object can then be passed into other methods to fill out its properties.
909 <P>
910 <DT><B>Parameters:</B><DD><CODE>server</CODE> - the server on which the partition resides
911 <DT><B>Throws:</B>
912 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
913
914 <!-- ============ METHOD DETAIL ========== -->
915
916 <A NAME="method_detail"><!-- --></A>
917 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
918 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
919 <TD COLSPAN=1><FONT SIZE="+2">
920 <B>Method Detail</B></FONT></TD>
921 </TR>
922 </TABLE>
923
924 <A NAME="refresh()"><!-- --></A><H3>
925 refresh</H3>
926 <PRE>
927 public void <B>refresh</B>()
928              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
929 <DL>
930 <DD>Refreshes the properties of this Partition object instance with values 
931  from the AFS partition
932  it represents.  All properties that have been initialized and/or 
933  accessed will be renewed according to the values of the AFS partition 
934  this Partition object instance represents.
935
936  <P>Since in most environments administrative changes can be administered
937  from an AFS command-line program or an alternate GUI application, this
938  method provides a means to refresh the Java object representation and
939  thereby ascertain any possible modifications that may have been made
940  from such alternate administrative programs.  Using this method before
941  an associated instance accessor will ensure the highest level of 
942  representative accuracy, accommodating changes made external to the
943  Java application space.  If administrative changes to the underlying AFS 
944  system are only allowed via this API, then the use of this method is 
945  unnecessary.
946 <P>
947 <DD><DL>
948 </DL>
949 </DD>
950 <DD><DL>
951
952 <DT><B>Throws:</B>
953 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
954 </DD>
955 </DL>
956 <HR>
957
958 <A NAME="refresh(boolean)"><!-- --></A><H3>
959 refresh</H3>
960 <PRE>
961 protected void <B>refresh</B>(boolean&nbsp;all)
962                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
963 <DL>
964 <DD>Refreshes the properties of this Partition object instance with values 
965  from the AFS partition it represents.  If <CODE>all</CODE> is 
966  <CODE>true</CODE> then <U>all</U> of the properties of this Partition 
967  object instance will be set, or renewed, according to the values of the 
968  AFS partition it represents, disregarding any previously set properties.
969
970  <P> Thus, if <CODE>all</CODE> is <CODE>false</CODE> then properties 
971  that are currently set will be refreshed and properties that are not 
972  set will remain uninitialized. See <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> for more 
973  information.
974 <P>
975 <DD><DL>
976 </DL>
977 </DD>
978 <DD><DL>
979 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties; otherwise 
980  renew all set properties
981 <DT><B>Throws:</B>
982 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
983 </DD>
984 </DL>
985 <HR>
986
987 <A NAME="refreshInfo()"><!-- --></A><H3>
988 refreshInfo</H3>
989 <PRE>
990 protected void <B>refreshInfo</B>()
991                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
992 <DL>
993 <DD>Refreshes the information fields of this <code>Partition</code> to 
994  reflect the current state of the AFS partition. These include total
995  free space, id, etc.
996 <P>
997 <DD><DL>
998 </DL>
999 </DD>
1000 <DD><DL>
1001
1002 <DT><B>Throws:</B>
1003 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1004 </DD>
1005 </DL>
1006 <HR>
1007
1008 <A NAME="refreshVolumes()"><!-- --></A><H3>
1009 refreshVolumes</H3>
1010 <PRE>
1011 protected void <B>refreshVolumes</B>()
1012                        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1013 <DL>
1014 <DD>Obtains the most current list of <code>Volume</code> objects of this 
1015  partition.
1016 <P>
1017 <DD><DL>
1018 </DL>
1019 </DD>
1020 <DD><DL>
1021
1022 <DT><B>Throws:</B>
1023 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1024 </DD>
1025 </DL>
1026 <HR>
1027
1028 <A NAME="refreshVolumeNames()"><!-- --></A><H3>
1029 refreshVolumeNames</H3>
1030 <PRE>
1031 protected void <B>refreshVolumeNames</B>()
1032                            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1033 <DL>
1034 <DD>Obtains the most current list of volume names of this partition.
1035 <P>
1036 <DD><DL>
1037 </DL>
1038 </DD>
1039 <DD><DL>
1040
1041 <DT><B>Throws:</B>
1042 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1043 </DD>
1044 </DL>
1045 <HR>
1046
1047 <A NAME="syncPartition()"><!-- --></A><H3>
1048 syncPartition</H3>
1049 <PRE>
1050 public void <B>syncPartition</B>()
1051                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1052 <DL>
1053 <DD>Syncs this partition to the VLDB.
1054 <P>
1055 <DD><DL>
1056 </DL>
1057 </DD>
1058 <DD><DL>
1059
1060 <DT><B>Throws:</B>
1061 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1062 </DD>
1063 </DL>
1064 <HR>
1065
1066 <A NAME="syncVLDB()"><!-- --></A><H3>
1067 syncVLDB</H3>
1068 <PRE>
1069 public void <B>syncVLDB</B>()
1070               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1071 <DL>
1072 <DD>Syncs the VLDB to this partition.
1073 <P>
1074 <DD><DL>
1075 </DL>
1076 </DD>
1077 <DD><DL>
1078
1079 <DT><B>Throws:</B>
1080 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1081 </DD>
1082 </DL>
1083 <HR>
1084
1085 <A NAME="salvage()"><!-- --></A><H3>
1086 salvage</H3>
1087 <PRE>
1088 public void <B>salvage</B>()
1089              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1090 <DL>
1091 <DD>Salvages (restores consistency to) this partition. Uses default values for
1092  most salvager options in order to simplify the API.
1093 <P>
1094 <DD><DL>
1095 </DL>
1096 </DD>
1097 <DD><DL>
1098
1099 <DT><B>Throws:</B>
1100 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1101 </DD>
1102 </DL>
1103 <HR>
1104
1105 <A NAME="getName()"><!-- --></A><H3>
1106 getName</H3>
1107 <PRE>
1108 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
1109 <DL>
1110 <DD>Returns the name of this partition.
1111 <P>
1112 <DD><DL>
1113 </DL>
1114 </DD>
1115 <DD><DL>
1116
1117 <DT><B>Returns:</B><DD>the name of this partition</DL>
1118 </DD>
1119 </DL>
1120 <HR>
1121
1122 <A NAME="getServer()"><!-- --></A><H3>
1123 getServer</H3>
1124 <PRE>
1125 public <A HREF="../../../org/openafs/jafs/Server.html">Server</A> <B>getServer</B>()</PRE>
1126 <DL>
1127 <DD>Returns this partition's hosting server.
1128 <P>
1129 <DD><DL>
1130 </DL>
1131 </DD>
1132 <DD><DL>
1133
1134 <DT><B>Returns:</B><DD>this partition's server</DL>
1135 </DD>
1136 </DL>
1137 <HR>
1138
1139 <A NAME="getVolumeCount()"><!-- --></A><H3>
1140 getVolumeCount</H3>
1141 <PRE>
1142 public int <B>getVolumeCount</B>()
1143                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1144 <DL>
1145 <DD>Returns the number of volumes contained in this partition.
1146
1147  <P>If the total list of volumes or volume names have already been
1148  collected (see <A HREF="../../../org/openafs/jafs/Partition.html#getVolumes()"><CODE>getVolumes()</CODE></A>), then the returning value will
1149  be calculated based upon the current list.  Otherwise, AFS will be
1150  explicitly queried for the information.
1151
1152  <P> The product of this method is not saved, and is recalculated
1153  with every call.
1154 <P>
1155 <DD><DL>
1156 </DL>
1157 </DD>
1158 <DD><DL>
1159
1160 <DT><B>Returns:</B><DD>the number of volumes contained in this partition.
1161 <DT><B>Throws:</B>
1162 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in any 
1163                                of the associated native methods</DL>
1164 </DD>
1165 </DL>
1166 <HR>
1167
1168 <A NAME="getVolume(java.lang.String)"><!-- --></A><H3>
1169 getVolume</H3>
1170 <PRE>
1171 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> <B>getVolume</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)
1172                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1173 <DL>
1174 <DD>Retrieves the <CODE>Volume</CODE> object (which is an abstract 
1175  representation of an actual AFS volume of this partition) designated 
1176  by <code>name</code> (i.e. "root.afs", etc.).  If a volume by 
1177  that name does not actually exist in AFS on the partition
1178  represented by this object, an <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> will be
1179  thrown.
1180 <P>
1181 <DD><DL>
1182 </DL>
1183 </DD>
1184 <DD><DL>
1185 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the volume to retrieve
1186 <DT><B>Returns:</B><DD><CODE>Volume</CODE> designated by <code>name</code>.
1187 <DT><B>Throws:</B>
1188 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code
1189 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <CODE>name</CODE> is 
1190                                   <CODE>null</CODE>.</DL>
1191 </DD>
1192 </DL>
1193 <HR>
1194
1195 <A NAME="getVolumes()"><!-- --></A><H3>
1196 getVolumes</H3>
1197 <PRE>
1198 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>[] <B>getVolumes</B>()
1199                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1200 <DL>
1201 <DD>Retrieves an array containing all of the <code>Volume</code> objects 
1202  associated with this <code>Partition</code>, each of which is an 
1203  abstract representation of an actual AFS volume of the AFS partition.
1204  After this method is called once, it saves the array of 
1205  <code>Volume</code>s and returns that saved array on subsequent calls, 
1206  until the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current list 
1207  is obtained.
1208 <P>
1209 <DD><DL>
1210 </DL>
1211 </DD>
1212 <DD><DL>
1213
1214 <DT><B>Returns:</B><DD>a <code>Volume</code> array of the <code>Volume</code> 
1215          objects of the partition.
1216 <DT><B>Throws:</B>
1217 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1218 </DD>
1219 </DL>
1220 <HR>
1221
1222 <A NAME="getVolumes(int, int)"><!-- --></A><H3>
1223 getVolumes</H3>
1224 <PRE>
1225 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>[] <B>getVolumes</B>(int&nbsp;startIndex,
1226                            int&nbsp;length)
1227                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1228 <DL>
1229 <DD>Returns an array containing a subset of the <code>Volume</code> objects
1230  associated with this <code>Partition</code>, each of which is an abstract
1231  representation of an actual AFS volume of the AFS partition.  The subset
1232  is a point-in-time list of volumes (<code>Volume</code> objects
1233  representing AFS volumes) starting at the complete array's index of
1234  <code>startIndex</code> and containing up to <code>length</code>
1235  elements.
1236
1237  If <code>length</code> is larger than the number of remaining elements, 
1238  respective to <code>startIndex</code>, then this method will
1239  ignore the remaining positions requested by <code>length</code> and 
1240  return an array that contains the remaining number of elements found in 
1241  this partition's complete array of volumes.
1242
1243  <P>This method is especially useful when managing iterations of very
1244  large lists.  <A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount()"><CODE>getVolumeCount()</CODE></A> can be used to determine if
1245  iteration management is practical.
1246
1247  <P>This method does not save the resulting data and therefore 
1248  queries AFS for each call.
1249
1250  <P><B>Example:</B> If there are more than 50,000 volumes within this partition
1251  then only render them in increments of 10,000.
1252  <PRE>
1253  ...
1254    Volume[] volumes;
1255    if (partition.getVolumeCount() > 50000) {
1256      int index = 0;
1257      int length = 10000;
1258      while (index < partition.getVolumeCount()) {
1259        volumes = partition.<B>getVolumes</B>(index, length);
1260        for (int i = 0; i < volumes.length; i++) {
1261          ...
1262        }
1263        index += length;
1264        ...
1265      }
1266    } else {
1267      volumes = partition.getVolumes();
1268      for (int i = 0; i < volumes.length; i++) {
1269        ...
1270      }
1271    }
1272  ...
1273  </PRE>
1274 <P>
1275 <DD><DL>
1276 </DL>
1277 </DD>
1278 <DD><DL>
1279 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the base zero index position at which the subset array 
1280                     should start from, relative to the complete list of 
1281                     elements present in AFS.<DD><CODE>length</CODE> - the number of elements that the subset should contain
1282 <DT><B>Returns:</B><DD>a subset array of volumes hosted by this partition
1283 <DT><B>Throws:</B>
1284 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount()"><CODE>getVolumeCount()</CODE></A>, 
1285 <A HREF="../../../org/openafs/jafs/Partition.html#getVolumeNames(int, int)"><CODE>getVolumeNames(int, int)</CODE></A>, 
1286 <A HREF="../../../org/openafs/jafs/Partition.html#getVolumes()"><CODE>getVolumes()</CODE></A></DL>
1287 </DD>
1288 </DL>
1289 <HR>
1290
1291 <A NAME="getVolumeNames()"><!-- --></A><H3>
1292 getVolumeNames</H3>
1293 <PRE>
1294 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getVolumeNames</B>()
1295                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1296 <DL>
1297 <DD>Retrieves an array containing all of the names of volumes
1298  associated with this <code>Partition</code>. 
1299  After this method is called once, it saves the array of 
1300  <code>String</code>s and returns that saved array on subsequent calls, 
1301  until the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
1302  list is obtained.
1303 <P>
1304 <DD><DL>
1305 </DL>
1306 </DD>
1307 <DD><DL>
1308
1309 <DT><B>Returns:</B><DD>a <code>String</code> array of the volumes of the partition.
1310 <DT><B>Throws:</B>
1311 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1312 </DD>
1313 </DL>
1314 <HR>
1315
1316 <A NAME="getVolumeNames(int, int)"><!-- --></A><H3>
1317 getVolumeNames</H3>
1318 <PRE>
1319 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getVolumeNames</B>(int&nbsp;startIndex,
1320                                int&nbsp;length)
1321                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1322 <DL>
1323 <DD>Returns an array containing a subset of the names of volumes
1324  associated with this <code>Partition</code>.  The subset is a 
1325  point-in-time list of volume names starting at the complete array's 
1326  index of <code>startIndex</code> and containing up to <code>length</code>
1327  elements.
1328
1329  If <code>length</code> is larger than the number of remaining elements, 
1330  respective to <code>startIndex</code>, then this method will
1331  ignore the remaining positions requested by <code>length</code> and 
1332  return an array that contains the remaining number of elements found in 
1333  this partition's complete array of volume names.
1334
1335  <P>This method is especially useful when managing iterations of very
1336  large lists.  <A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount()"><CODE>getVolumeCount()</CODE></A> can be used to determine if
1337  iteration management is practical.
1338
1339  <P>This method does not save the resulting data and therefore 
1340  queries AFS for each call.
1341
1342  <P><B>Example:</B> If there are more than 50,000 volumes within this partition
1343  then only render them in increments of 10,000.
1344  <PRE>
1345  ...
1346    String[] volumes;
1347    if (partition.getVolumeCount() > 50000) {
1348      int index = 0;
1349      int length = 10000;
1350      while (index < partition.getVolumeCount()) {
1351        volumes = partition.<B>getVolumeNames</B>(index, length);
1352        for (int i = 0; i < volumes.length; i++) {
1353          ...
1354        }
1355        index += length;
1356        ...
1357      }
1358    } else {
1359      volumes = partition.getVolumeNames();
1360      for (int i = 0; i < volumes.length; i++) {
1361        ...
1362      }
1363    }
1364  ...
1365  </PRE>
1366 <P>
1367 <DD><DL>
1368 </DL>
1369 </DD>
1370 <DD><DL>
1371 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the base zero index position at which the subset array 
1372                     should start from, relative to the complete list of 
1373                     elements present in AFS.<DD><CODE>length</CODE> - the number of elements that the subset should contain
1374 <DT><B>Returns:</B><DD>a subset array of volume names hosted by this partition
1375 <DT><B>Throws:</B>
1376 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount()"><CODE>getVolumeCount()</CODE></A>, 
1377 <A HREF="../../../org/openafs/jafs/Partition.html#getVolumes(int, int)"><CODE>getVolumes(int, int)</CODE></A>, 
1378 <A HREF="../../../org/openafs/jafs/Partition.html#getVolumes()"><CODE>getVolumes()</CODE></A></DL>
1379 </DD>
1380 </DL>
1381 <HR>
1382
1383 <A NAME="getID()"><!-- --></A><H3>
1384 getID</H3>
1385 <PRE>
1386 public int <B>getID</B>()
1387           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1388 <DL>
1389 <DD>Returns the id of this partition (i.e. "vicepa" = 0, etc.)
1390 <P>
1391 <DD><DL>
1392 </DL>
1393 </DD>
1394 <DD><DL>
1395
1396 <DT><B>Returns:</B><DD>the id of this partition
1397 <DT><B>Throws:</B>
1398 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1399 </DD>
1400 </DL>
1401 <HR>
1402
1403 <A NAME="getDeviceName()"><!-- --></A><H3>
1404 getDeviceName</H3>
1405 <PRE>
1406 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getDeviceName</B>()
1407                      throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1408 <DL>
1409 <DD>Returns the device name of this partition (i.e. "hda5", etc.)
1410 <P>
1411 <DD><DL>
1412 </DL>
1413 </DD>
1414 <DD><DL>
1415
1416 <DT><B>Returns:</B><DD>the device name of this partition
1417 <DT><B>Throws:</B>
1418 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1419 </DD>
1420 </DL>
1421 <HR>
1422
1423 <A NAME="getLockFileDescriptor()"><!-- --></A><H3>
1424 getLockFileDescriptor</H3>
1425 <PRE>
1426 public int <B>getLockFileDescriptor</B>()
1427                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1428 <DL>
1429 <DD>Returns the lock file descriptor of this partition
1430 <P>
1431 <DD><DL>
1432 </DL>
1433 </DD>
1434 <DD><DL>
1435
1436 <DT><B>Returns:</B><DD>the lock file descriptor of this partition
1437 <DT><B>Throws:</B>
1438 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1439 </DD>
1440 </DL>
1441 <HR>
1442
1443 <A NAME="getTotalSpace()"><!-- --></A><H3>
1444 getTotalSpace</H3>
1445 <PRE>
1446 public int <B>getTotalSpace</B>()
1447                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1448 <DL>
1449 <DD>Returns the total space on this partition.
1450 <P>
1451 <DD><DL>
1452 </DL>
1453 </DD>
1454 <DD><DL>
1455
1456 <DT><B>Returns:</B><DD>the total space on this partition
1457 <DT><B>Throws:</B>
1458 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1459 </DD>
1460 </DL>
1461 <HR>
1462
1463 <A NAME="getTotalFreeSpace()"><!-- --></A><H3>
1464 getTotalFreeSpace</H3>
1465 <PRE>
1466 public int <B>getTotalFreeSpace</B>()
1467                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1468 <DL>
1469 <DD>Returns the total free space on this partition.
1470  After this method is called once, it saves the total free space 
1471  and returns that value on subsequent calls, 
1472  until the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
1473  value is obtained.
1474 <P>
1475 <DD><DL>
1476 </DL>
1477 </DD>
1478 <DD><DL>
1479
1480 <DT><B>Returns:</B><DD>the total free space on this partition
1481 <DT><B>Throws:</B>
1482 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1483 </DD>
1484 </DL>
1485 <HR>
1486
1487 <A NAME="getUsedSpace()"><!-- --></A><H3>
1488 getUsedSpace</H3>
1489 <PRE>
1490 public int <B>getUsedSpace</B>()
1491                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1492 <DL>
1493 <DD>Returns the total used space on this partition.
1494  After this method is called once, it saves the total used space 
1495  and returns that value on subsequent calls, 
1496  until the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
1497  value is obtained.
1498 <P>
1499 <DD><DL>
1500 </DL>
1501 </DD>
1502 <DD><DL>
1503
1504 <DT><B>Returns:</B><DD>the total used space on this partition
1505 <DT><B>Throws:</B>
1506 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1507 </DD>
1508 </DL>
1509 <HR>
1510
1511 <A NAME="getTotalQuota()"><!-- --></A><H3>
1512 getTotalQuota</H3>
1513 <PRE>
1514 public int <B>getTotalQuota</B>()
1515                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1516 <DL>
1517 <DD>Returns the total combined quota of all volumes on this partition,
1518  unless a volume has configured an unlimited quota at which case an
1519  <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> is thrown.
1520
1521  <P>After this method is called once, it saves the value and returns 
1522  that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> 
1523  method is called and a more current value is obtained.
1524 <P>
1525 <DD><DL>
1526 </DL>
1527 </DD>
1528 <DD><DL>
1529
1530 <DT><B>Returns:</B><DD>the total combined quota of all volumes on this partition
1531 <DT><B>Throws:</B>
1532 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs while retrieving and 
1533                                calculating, or a volume has an 
1534                                unlimited quota.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota(boolean)"><CODE>getTotalQuota(boolean)</CODE></A>, 
1535 <A HREF="../../../org/openafs/jafs/Partition.html#hasVolumeWithUnlimitedQuota()"><CODE>hasVolumeWithUnlimitedQuota()</CODE></A>, 
1536 <A HREF="../../../org/openafs/jafs/Volume.html#getQuota()"><CODE>Volume.getQuota()</CODE></A></DL>
1537 </DD>
1538 </DL>
1539 <HR>
1540
1541 <A NAME="getTotalQuota(boolean)"><!-- --></A><H3>
1542 getTotalQuota</H3>
1543 <PRE>
1544 public int <B>getTotalQuota</B>(boolean&nbsp;ignoreUnlimitedQuotas)
1545                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1546 <DL>
1547 <DD>Returns the total combined quota of all volumes on this partition,
1548  ignoring volumes with unlimited quotas, if <CODE>
1549  ignoreUnlimitedQuotas</CODE> is <CODE>true</CODE>; otherwise an
1550  <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> is thrown if a volume has an unlimited quota.
1551
1552  <P>After this method is called once, it saves the value and returns 
1553  that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A> 
1554  method is called and a more current value is obtained.
1555 <P>
1556 <DD><DL>
1557 </DL>
1558 </DD>
1559 <DD><DL>
1560
1561 <DT><B>Returns:</B><DD>the total combined quota of all volumes on this partition
1562 <DT><B>Throws:</B>
1563 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs while retrieving and 
1564                                calculating, or a volume has an 
1565                                unlimited quota.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota()"><CODE>getTotalQuota()</CODE></A>, 
1566 <A HREF="../../../org/openafs/jafs/Partition.html#hasVolumeWithUnlimitedQuota()"><CODE>hasVolumeWithUnlimitedQuota()</CODE></A>, 
1567 <A HREF="../../../org/openafs/jafs/Volume.html#getQuota()"><CODE>Volume.getQuota()</CODE></A>, 
1568 <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1569 </DD>
1570 </DL>
1571 <HR>
1572
1573 <A NAME="hasVolumeWithUnlimitedQuota()"><!-- --></A><H3>
1574 hasVolumeWithUnlimitedQuota</H3>
1575 <PRE>
1576 public boolean <B>hasVolumeWithUnlimitedQuota</B>()
1577                                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1578 <DL>
1579 <DD>Tests whether this partition contains a volume that has an unlimited
1580  quota configured.
1581 <P>
1582 <DD><DL>
1583 </DL>
1584 </DD>
1585 <DD><DL>
1586
1587 <DT><B>Returns:</B><DD><CODE>true</CODE> if a contained volume's quota is configured
1588          as unlimited; otherwise <CODE>false</CODE>.
1589 <DT><B>Throws:</B>
1590 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota()"><CODE>getTotalQuota()</CODE></A>, 
1591 <A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota(boolean)"><CODE>getTotalQuota(boolean)</CODE></A>, 
1592 <A HREF="../../../org/openafs/jafs/Volume.html#isQuotaUnlimited()"><CODE>Volume.isQuotaUnlimited()</CODE></A>, 
1593 <A HREF="../../../org/openafs/jafs/Volume.html#getQuota()"><CODE>Volume.getQuota()</CODE></A>, 
1594 <A HREF="../../../org/openafs/jafs/Partition.html#refresh()"><CODE>refresh()</CODE></A></DL>
1595 </DD>
1596 </DL>
1597 <HR>
1598
1599 <A NAME="getInfo()"><!-- --></A><H3>
1600 getInfo</H3>
1601 <PRE>
1602 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
1603 <DL>
1604 <DD>Returns a <code>String</code> representation of this 
1605  <code>Partition</code>.  Contains the information fields and a list of 
1606  volumes.
1607 <P>
1608 <DD><DL>
1609 </DL>
1610 </DD>
1611 <DD><DL>
1612
1613 <DT><B>Returns:</B><DD>a <code>String</code> representation of the <code>Partition</code></DL>
1614 </DD>
1615 </DL>
1616 <HR>
1617
1618 <A NAME="getInfoVolumes()"><!-- --></A><H3>
1619 getInfoVolumes</H3>
1620 <PRE>
1621 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfoVolumes</B>()
1622                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1623 <DL>
1624 <DD>Returns a <code>String</code> containing the <code>String</code> 
1625  representations of all the volumes of this <code>Partition</code>.
1626 <P>
1627 <DD><DL>
1628 </DL>
1629 </DD>
1630 <DD><DL>
1631
1632 <DT><B>Returns:</B><DD>a <code>String</code> representation of the volumes
1633 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Volume.html#getInfo()"><CODE>Volume.getInfo()</CODE></A></DL>
1634 </DD>
1635 </DL>
1636 <HR>
1637
1638 <A NAME="compareTo(org.openafs.jafs.Partition)"><!-- --></A><H3>
1639 compareTo</H3>
1640 <PRE>
1641 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition)</PRE>
1642 <DL>
1643 <DD>Compares two Partition objects respective to their names and does not
1644  factor any other attribute.    Alphabetic case is significant in 
1645  comparing names.
1646 <P>
1647 <DD><DL>
1648 </DL>
1649 </DD>
1650 <DD><DL>
1651 <DT><B>Parameters:</B><DD><CODE>partition</CODE> - The Partition object to be compared to 
1652                          this Partition instance
1653 <DT><B>Returns:</B><DD>Zero if the argument is equal to this Partition's name, a
1654                 value less than zero if this Partition's name is
1655                 lexicographically less than the argument, or a value greater
1656                 than zero if this Partition's name is lexicographically
1657                 greater than the argument</DL>
1658 </DD>
1659 </DL>
1660 <HR>
1661
1662 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
1663 compareTo</H3>
1664 <PRE>
1665 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</PRE>
1666 <DL>
1667 <DD>Comparable interface method.
1668 <P>
1669 <DD><DL>
1670 <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></CODE></DL>
1671 </DD>
1672 <DD><DL>
1673 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#compareTo(org.openafs.jafs.Partition)"><CODE>compareTo(Partition)</CODE></A></DL>
1674 </DD>
1675 </DL>
1676 <HR>
1677
1678 <A NAME="equals(org.openafs.jafs.Partition)"><!-- --></A><H3>
1679 equals</H3>
1680 <PRE>
1681 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;otherPartition)</PRE>
1682 <DL>
1683 <DD>Tests whether two <code>Partition</code> objects are equal, 
1684  based on their names and hosting server.
1685 <P>
1686 <DD><DL>
1687 </DL>
1688 </DD>
1689 <DD><DL>
1690 <DT><B>Parameters:</B><DD><CODE>otherPartition</CODE> - the Partition to test
1691 <DT><B>Returns:</B><DD>whether the specifed Partition is the same as this Partition</DL>
1692 </DD>
1693 </DL>
1694 <HR>
1695
1696 <A NAME="toString()"><!-- --></A><H3>
1697 toString</H3>
1698 <PRE>
1699 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
1700 <DL>
1701 <DD>Returns the name of this <CODE>Partition</CODE>
1702 <P>
1703 <DD><DL>
1704 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></CODE></DL>
1705 </DD>
1706 <DD><DL>
1707
1708 <DT><B>Returns:</B><DD>the name of this <CODE>Partition</CODE></DL>
1709 </DD>
1710 </DL>
1711 <HR>
1712
1713 <A NAME="getPartitionInfo(int, int, int, org.openafs.jafs.Partition)"><!-- --></A><H3>
1714 getPartitionInfo</H3>
1715 <PRE>
1716 protected static void <B>getPartitionInfo</B>(int&nbsp;cellHandle,
1717                                        int&nbsp;serverHandle,
1718                                        int&nbsp;partition,
1719                                        <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;thePartition)
1720                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1721 <DL>
1722 <DD>Fills in the information fields of the provided <code>Partition</code>.
1723 <P>
1724 <DD><DL>
1725 </DL>
1726 </DD>
1727 <DD><DL>
1728 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the partition belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the 
1729                       partition resides<DD><CODE>partition</CODE> - the numeric id of the partition for which to get the 
1730                     info<DD><CODE>thePartition</CODE> - the <A HREF="../../../org/openafs/jafs/Partition.html"><CODE>Partition</CODE></A> object in which to 
1731                        fill in the information
1732 <DT><B>Throws:</B>
1733 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
1734 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
1735 </DD>
1736 </DL>
1737 <HR>
1738
1739 <A NAME="getVolumeCount(int, int, int)"><!-- --></A><H3>
1740 getVolumeCount</H3>
1741 <PRE>
1742 protected static int <B>getVolumeCount</B>(int&nbsp;cellHandle,
1743                                     int&nbsp;serverHandle,
1744                                     int&nbsp;partition)
1745                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1746 <DL>
1747 <DD>Returns the total number of volumes hosted by this partition.
1748 <P>
1749 <DD><DL>
1750 </DL>
1751 </DD>
1752 <DD><DL>
1753 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the partition belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server to which the partition 
1754                       belongs<DD><CODE>partition</CODE> - the numeric id of the partition on which the volumes 
1755                     reside
1756 <DT><B>Returns:</B><DD>total number of volumes hosted by this partition
1757 <DT><B>Throws:</B>
1758 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
1759 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
1760 </DD>
1761 </DL>
1762 <HR>
1763
1764 <A NAME="getVolumesBegin(int, int, int)"><!-- --></A><H3>
1765 getVolumesBegin</H3>
1766 <PRE>
1767 protected static int <B>getVolumesBegin</B>(int&nbsp;cellHandle,
1768                                      int&nbsp;serverHandle,
1769                                      int&nbsp;partition)
1770                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1771 <DL>
1772 <DD>Begin the process of getting the volumes on a partition.  Returns 
1773  an iteration ID to be used by subsequent calls to 
1774  <code>getVolumesNext</code> and <code>getVolumesDone</code>.
1775 <P>
1776 <DD><DL>
1777 </DL>
1778 </DD>
1779 <DD><DL>
1780 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the partition belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server to which the partition 
1781                       belongs<DD><CODE>partition</CODE> - the numeric id of the partition on which the volumes 
1782                     reside
1783 <DT><B>Returns:</B><DD>an iteration ID
1784 <DT><B>Throws:</B>
1785 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
1786 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
1787 </DD>
1788 </DL>
1789 <HR>
1790
1791 <A NAME="getVolumesBeginAt(int, int, int, int)"><!-- --></A><H3>
1792 getVolumesBeginAt</H3>
1793 <PRE>
1794 protected static int <B>getVolumesBeginAt</B>(int&nbsp;cellHandle,
1795                                        int&nbsp;serverHandle,
1796                                        int&nbsp;partition,
1797                                        int&nbsp;index)
1798                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1799 <DL>
1800 <DD>Begin the process of getting the volumes on a partition.  Returns 
1801  an iteration ID to be used by subsequent calls to 
1802  <code>getVolumesNext</code> and <code>getVolumesDone</code>.
1803 <P>
1804 <DD><DL>
1805 </DL>
1806 </DD>
1807 <DD><DL>
1808 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the partition belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server to which the partition 
1809                       belongs<DD><CODE>partition</CODE> - the numeric id of the partition on which the volumes 
1810                     reside
1811 <DT><B>Returns:</B><DD>an iteration ID
1812 <DT><B>Throws:</B>
1813 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
1814 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
1815 </DD>
1816 </DL>
1817 <HR>
1818
1819 <A NAME="getVolumesNextString(int)"><!-- --></A><H3>
1820 getVolumesNextString</H3>
1821 <PRE>
1822 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getVolumesNextString</B>(int&nbsp;iterationId)
1823                                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1824 <DL>
1825 <DD>Returns the next volume of the partition.  Returns <code>null</code> 
1826  if there are no more volumes.
1827 <P>
1828 <DD><DL>
1829 </DL>
1830 </DD>
1831 <DD><DL>
1832 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
1833 <DT><B>Returns:</B><DD>the name of the next volume of the server
1834 <DT><B>Throws:</B>
1835 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBegin(int, int, int)"><CODE>getVolumesBegin(int, int, int)</CODE></A></DL>
1836 </DD>
1837 </DL>
1838 <HR>
1839
1840 <A NAME="getVolumesNext(int, org.openafs.jafs.Volume)"><!-- --></A><H3>
1841 getVolumesNext</H3>
1842 <PRE>
1843 protected static int <B>getVolumesNext</B>(int&nbsp;iterationId,
1844                                     <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;theVolume)
1845                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1846 <DL>
1847 <DD>Fills the next volume object of the partition.  Returns 0 if there
1848  are no more volumes, != 0 otherwise.
1849 <P>
1850 <DD><DL>
1851 </DL>
1852 </DD>
1853 <DD><DL>
1854 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration<DD><CODE>theVolume</CODE> - the Volume object in which to fill the values 
1855                      of the next volume
1856 <DT><B>Returns:</B><DD>0 if there are no more volumes, != 0 otherwise
1857 <DT><B>Throws:</B>
1858 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBegin(int, int, int)"><CODE>getVolumesBegin(int, int, int)</CODE></A></DL>
1859 </DD>
1860 </DL>
1861 <HR>
1862
1863 <A NAME="getVolumesAdvanceTo(int, org.openafs.jafs.Volume, int)"><!-- --></A><H3>
1864 getVolumesAdvanceTo</H3>
1865 <PRE>
1866 protected static int <B>getVolumesAdvanceTo</B>(int&nbsp;iterationId,
1867                                          <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;theVolume,
1868                                          int&nbsp;advanceCount)
1869                                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1870 <DL>
1871 <DD>Fills the next volume object of the partition.  Returns 0 if there
1872  are no more volumes, != 0 otherwise.
1873 <P>
1874 <DD><DL>
1875 </DL>
1876 </DD>
1877 <DD><DL>
1878 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration<DD><CODE>theVolume</CODE> - the Volume object in which to fill the values of the 
1879                      next volume
1880 <DT><B>Returns:</B><DD>0 if there are no more volumes, != 0 otherwise
1881 <DT><B>Throws:</B>
1882 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBegin(int, int, int)"><CODE>getVolumesBegin(int, int, int)</CODE></A></DL>
1883 </DD>
1884 </DL>
1885 <HR>
1886
1887 <A NAME="getVolumesDone(int)"><!-- --></A><H3>
1888 getVolumesDone</H3>
1889 <PRE>
1890 protected static void <B>getVolumesDone</B>(int&nbsp;iterationId)
1891                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1892 <DL>
1893 <DD>Signals that the iteration is complete and will not be accessed anymore.
1894 <P>
1895 <DD><DL>
1896 </DL>
1897 </DD>
1898 <DD><DL>
1899 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
1900 <DT><B>Throws:</B>
1901 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBegin(int, int, int)"><CODE>getVolumesBegin(int, int, int)</CODE></A></DL>
1902 </DD>
1903 </DL>
1904 <HR>
1905
1906 <A NAME="translateNameToID(java.lang.String)"><!-- --></A><H3>
1907 translateNameToID</H3>
1908 <PRE>
1909 protected static int <B>translateNameToID</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)
1910                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1911 <DL>
1912 <DD>Translates a partition name into a partition id
1913 <P>
1914 <DD><DL>
1915 </DL>
1916 </DD>
1917 <DD><DL>
1918 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the partition in question
1919 <DT><B>Returns:</B><DD>the id of the partition in question
1920 <DT><B>Throws:</B>
1921 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1922 </DD>
1923 </DL>
1924 <HR>
1925
1926 <A NAME="translateIDToName(int)"><!-- --></A><H3>
1927 translateIDToName</H3>
1928 <PRE>
1929 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>translateIDToName</B>(int&nbsp;id)
1930                                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1931 <DL>
1932 <DD>Translates a partition id into a partition name
1933 <P>
1934 <DD><DL>
1935 </DL>
1936 </DD>
1937 <DD><DL>
1938 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of the partition in question
1939 <DT><B>Returns:</B><DD>the name of the partition in question
1940 <DT><B>Throws:</B>
1941 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1942 </DD>
1943 </DL>
1944 <HR>
1945
1946 <A NAME="reclaimPartitionMemory()"><!-- --></A><H3>
1947 reclaimPartitionMemory</H3>
1948 <PRE>
1949 protected static void <B>reclaimPartitionMemory</B>()</PRE>
1950 <DL>
1951 <DD>Reclaims all memory being saved by the partition portion of the native 
1952  library. This method should be called when no more <code>Partition</code> 
1953  objects are expected to be
1954  used.
1955 <P>
1956 <DD><DL>
1957 </DL>
1958 </DD>
1959 <DD><DL>
1960 </DL>
1961 </DD>
1962 </DL>
1963 <!-- ========= END OF CLASS DATA ========= -->
1964 <HR>
1965
1966 <!-- ========== START OF NAVBAR ========== -->
1967 <A NAME="navbar_bottom"><!-- --></A>
1968 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
1969 <TR>
1970 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1971 <A NAME="navbar_bottom_firstrow"><!-- --></A>
1972 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
1973   <TR ALIGN="center" VALIGN="top">
1974   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1975   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1976   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Partition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
1977   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1978   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1979   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1980   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1981   </TR>
1982 </TABLE>
1983 </TD>
1984 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1985 <B>JAFS API v2</B></EM>
1986 </TD>
1987 </TR>
1988
1989 <TR>
1990 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1991 &nbsp;<A HREF="../../../org/openafs/jafs/Key.html"><B>PREV CLASS</B></A>&nbsp;
1992 &nbsp;<A HREF="../../../org/openafs/jafs/Process.html"><B>NEXT CLASS</B></A></FONT></TD>
1993 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1994   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
1995 &nbsp;<A HREF="Partition.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
1996 &nbsp;
1997 <SCRIPT>
1998   <!--
1999   if(window==top) {
2000     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
2001   }
2002   //-->
2003 </SCRIPT>
2004 <NOSCRIPT>
2005 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
2006 </NOSCRIPT>
2007 </FONT></TD>
2008 </TR>
2009 <TR>
2010 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2011   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
2012 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2013 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
2014 </TR>
2015 </TABLE>
2016 <!-- =========== END OF NAVBAR =========== -->
2017
2018 <HR>
2019
2020 </BODY>
2021 </HTML>