1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
5 <!-- Generated by javadoc on Mon Jun 09 15:53:37 PDT 2003 -->
7 Partition (Java AFS API)
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Partition,Partition class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="Partition (Java AFS API)";
18 <BODY BGCOLOR="white" onload="asd();">
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
29 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
30 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Partition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
31 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 <A HREF="../../../org/openafs/jafs/Key.html"><B>PREV CLASS</B></A>
46 <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>
49 <A HREF="Partition.html" TARGET="_top"><B>NO FRAMES</B></A>
54 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
70 <!-- =========== END OF NAVBAR =========== -->
73 <!-- ======== START OF CLASS DATA ======== -->
76 org.openafs.jafs</FONT>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
82 +--<B>org.openafs.jafs.Partition</B>
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>
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>
92 An abstract representation of an AFS partition. It holds information about
93 the partition, such as what its total space is.
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>
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>
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>
113 import org.openafs.jafs.Cell;
114 import org.openafs.jafs.AFSException;
115 import org.openafs.jafs.Partition;
116 import org.openafs.jafs.Server;
122 private Server server;
124 public static void main(String[] args) throws Exception
126 String username = arg[0];
127 String password = arg[1];
128 String cellName = arg[2];
129 String serverName = arg[3];
131 token = new Token(username, password, cellName);
132 cell = new Cell(token);
133 server = new Server(serverName, cell);
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");
150 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Partition">Serialized Form</A></DL>
154 <!-- ======== NESTED CLASS SUMMARY ======== -->
157 <!-- =========== FIELD SUMMARY =========== -->
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>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167 <CODE>protected boolean</CODE></FONT></TD>
168 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#cachedInfo">cachedInfo</A></B></CODE>
171 </TD>
173 <TR BGCOLOR="white" CLASS="TableRowColor">
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175 <CODE>protected <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>
179 </TD>
181 <TR BGCOLOR="white" CLASS="TableRowColor">
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183 <CODE>protected <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>
187 </TD>
189 <TR BGCOLOR="white" CLASS="TableRowColor">
190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191 <CODE>protected int</CODE></FONT></TD>
192 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#id">id</A></B></CODE>
195 </TD>
197 <TR BGCOLOR="white" CLASS="TableRowColor">
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199 <CODE>protected int</CODE></FONT></TD>
200 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#lockFileDescriptor">lockFileDescriptor</A></B></CODE>
203 </TD>
205 <TR BGCOLOR="white" CLASS="TableRowColor">
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207 <CODE>protected <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>
211 </TD>
213 <TR BGCOLOR="white" CLASS="TableRowColor">
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215 <CODE>protected <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>
219 </TD>
221 <TR BGCOLOR="white" CLASS="TableRowColor">
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223 <CODE>protected int</CODE></FONT></TD>
224 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#totalFreeSpace">totalFreeSpace</A></B></CODE>
227 </TD>
229 <TR BGCOLOR="white" CLASS="TableRowColor">
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231 <CODE>protected int</CODE></FONT></TD>
232 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#totalQuota">totalQuota</A></B></CODE>
235 </TD>
237 <TR BGCOLOR="white" CLASS="TableRowColor">
238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239 <CODE>protected int</CODE></FONT></TD>
240 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#totalSpace">totalSpace</A></B></CODE>
243 </TD>
245 <TR BGCOLOR="white" CLASS="TableRowColor">
246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247 <CODE>protected <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>
251 </TD>
253 <TR BGCOLOR="white" CLASS="TableRowColor">
254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255 <CODE>protected <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>
259 </TD>
263 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
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>
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> server)</CODE>
277 Creates a blank <code>Server</code> given the cell to which the partition
278 belongs and the server on which the partition resides. </TD>
280 <TR BGCOLOR="white" CLASS="TableRowColor">
281 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282 <CODE> </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> name,
284 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)</CODE>
287 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>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE> </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> name,
295 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> server,
296 boolean preloadAllMembers)</CODE>
299 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>
305 <!-- ========== METHOD SUMMARY =========== -->
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>
313 <TR BGCOLOR="white" CLASS="TableRowColor">
314 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315 <CODE> 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> obj)</CODE>
319 Comparable interface method.</TD>
321 <TR BGCOLOR="white" CLASS="TableRowColor">
322 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323 <CODE> 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> partition)</CODE>
327 Compares two Partition objects respective to their names and does not
328 factor any other attribute. </TD>
330 <TR BGCOLOR="white" CLASS="TableRowColor">
331 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332 <CODE> 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> otherPartition)</CODE>
336 Tests whether two <code>Partition</code> objects are equal,
337 based on their names and hosting server.</TD>
339 <TR BGCOLOR="white" CLASS="TableRowColor">
340 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341 <CODE> <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>
345 Returns the device name of this partition (i.e. </TD>
347 <TR BGCOLOR="white" CLASS="TableRowColor">
348 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349 <CODE> int</CODE></FONT></TD>
350 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getID()">getID</A></B>()</CODE>
353 Returns the id of this partition (i.e. </TD>
355 <TR BGCOLOR="white" CLASS="TableRowColor">
356 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
357 <CODE>protected <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>
361 Returns a <code>String</code> representation of this
362 <code>Partition</code>. </TD>
364 <TR BGCOLOR="white" CLASS="TableRowColor">
365 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
366 <CODE>protected <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>
370 Returns a <code>String</code> containing the <code>String</code>
371 representations of all the volumes of this <code>Partition</code>.</TD>
373 <TR BGCOLOR="white" CLASS="TableRowColor">
374 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375 <CODE> int</CODE></FONT></TD>
376 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getLockFileDescriptor()">getLockFileDescriptor</A></B>()</CODE>
379 Returns the lock file descriptor of this partition</TD>
381 <TR BGCOLOR="white" CLASS="TableRowColor">
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383 <CODE> <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>
387 Returns the name of this partition.</TD>
389 <TR BGCOLOR="white" CLASS="TableRowColor">
390 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
391 <CODE>protected static 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 cellHandle,
393 int serverHandle,
395 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> thePartition)</CODE>
398 Fills in the information fields of the provided <code>Partition</code>.</TD>
400 <TR BGCOLOR="white" CLASS="TableRowColor">
401 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402 <CODE> <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>
406 Returns this partition's hosting server.</TD>
408 <TR BGCOLOR="white" CLASS="TableRowColor">
409 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410 <CODE> int</CODE></FONT></TD>
411 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalFreeSpace()">getTotalFreeSpace</A></B>()</CODE>
414 Returns the total free space on this partition.
417 <TR BGCOLOR="white" CLASS="TableRowColor">
418 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419 <CODE> int</CODE></FONT></TD>
420 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota()">getTotalQuota</A></B>()</CODE>
423 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.
429 <TR BGCOLOR="white" CLASS="TableRowColor">
430 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
431 <CODE> int</CODE></FONT></TD>
432 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalQuota(boolean)">getTotalQuota</A></B>(boolean ignoreUnlimitedQuotas)</CODE>
435 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.
442 <TR BGCOLOR="white" CLASS="TableRowColor">
443 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
444 <CODE> int</CODE></FONT></TD>
445 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getTotalSpace()">getTotalSpace</A></B>()</CODE>
448 Returns the total space on this partition.</TD>
450 <TR BGCOLOR="white" CLASS="TableRowColor">
451 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
452 <CODE> int</CODE></FONT></TD>
453 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getUsedSpace()">getUsedSpace</A></B>()</CODE>
456 Returns the total used space on this partition.
459 <TR BGCOLOR="white" CLASS="TableRowColor">
460 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
461 <CODE> <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> name)</CODE>
465 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>
469 <TR BGCOLOR="white" CLASS="TableRowColor">
470 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
471 <CODE> int</CODE></FONT></TD>
472 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount()">getVolumeCount</A></B>()</CODE>
475 Returns the number of volumes contained in this partition.
479 <TR BGCOLOR="white" CLASS="TableRowColor">
480 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
481 <CODE>protected static int</CODE></FONT></TD>
482 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumeCount(int, int, int)">getVolumeCount</A></B>(int cellHandle,
483 int serverHandle,
484 int partition)</CODE>
487 Returns the total number of volumes hosted by this partition.</TD>
489 <TR BGCOLOR="white" CLASS="TableRowColor">
490 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
491 <CODE> <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>
495 Retrieves an array containing all of the names of volumes
496 associated with this <code>Partition</code>.
499 <TR BGCOLOR="white" CLASS="TableRowColor">
500 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
501 <CODE> <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 startIndex,
503 int length)</CODE>
506 Returns an array containing a subset of the names of volumes
507 associated with this <code>Partition</code>. </TD>
509 <TR BGCOLOR="white" CLASS="TableRowColor">
510 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
511 <CODE> <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>
515 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.
520 <TR BGCOLOR="white" CLASS="TableRowColor">
521 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
522 <CODE> <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 startIndex,
524 int length)</CODE>
527 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>
531 <TR BGCOLOR="white" CLASS="TableRowColor">
532 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
533 <CODE>protected static 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 iterationId,
535 <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> theVolume,
536 int advanceCount)</CODE>
539 Fills the next volume object of the partition. </TD>
541 <TR BGCOLOR="white" CLASS="TableRowColor">
542 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
543 <CODE>protected static int</CODE></FONT></TD>
544 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBegin(int, int, int)">getVolumesBegin</A></B>(int cellHandle,
545 int serverHandle,
546 int partition)</CODE>
549 Begin the process of getting the volumes on a partition. </TD>
551 <TR BGCOLOR="white" CLASS="TableRowColor">
552 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
553 <CODE>protected static int</CODE></FONT></TD>
554 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesBeginAt(int, int, int, int)">getVolumesBeginAt</A></B>(int cellHandle,
555 int serverHandle,
557 int index)</CODE>
560 Begin the process of getting the volumes on a partition. </TD>
562 <TR BGCOLOR="white" CLASS="TableRowColor">
563 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
564 <CODE>protected static void</CODE></FONT></TD>
565 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#getVolumesDone(int)">getVolumesDone</A></B>(int iterationId)</CODE>
568 Signals that the iteration is complete and will not be accessed anymore.</TD>
570 <TR BGCOLOR="white" CLASS="TableRowColor">
571 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
572 <CODE>protected static 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 iterationId,
574 <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> theVolume)</CODE>
577 Fills the next volume object of the partition. </TD>
579 <TR BGCOLOR="white" CLASS="TableRowColor">
580 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
581 <CODE>protected static <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 iterationId)</CODE>
585 Returns the next volume of the partition. </TD>
587 <TR BGCOLOR="white" CLASS="TableRowColor">
588 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
589 <CODE> boolean</CODE></FONT></TD>
590 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#hasVolumeWithUnlimitedQuota()">hasVolumeWithUnlimitedQuota</A></B>()</CODE>
593 Tests whether this partition contains a volume that has an unlimited
594 quota configured.</TD>
596 <TR BGCOLOR="white" CLASS="TableRowColor">
597 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
598 <CODE>protected static void</CODE></FONT></TD>
599 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#reclaimPartitionMemory()">reclaimPartitionMemory</A></B>()</CODE>
602 Reclaims all memory being saved by the partition portion of the native
605 <TR BGCOLOR="white" CLASS="TableRowColor">
606 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
607 <CODE> void</CODE></FONT></TD>
608 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refresh()">refresh</A></B>()</CODE>
611 Refreshes the properties of this Partition object instance with values
612 from the AFS partition
615 <TR BGCOLOR="white" CLASS="TableRowColor">
616 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
617 <CODE>protected void</CODE></FONT></TD>
618 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refresh(boolean)">refresh</A></B>(boolean all)</CODE>
621 Refreshes the properties of this Partition object instance with values
622 from the AFS partition it represents. </TD>
624 <TR BGCOLOR="white" CLASS="TableRowColor">
625 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
626 <CODE>protected void</CODE></FONT></TD>
627 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refreshInfo()">refreshInfo</A></B>()</CODE>
630 Refreshes the information fields of this <code>Partition</code> to
631 reflect the current state of the AFS partition. </TD>
633 <TR BGCOLOR="white" CLASS="TableRowColor">
634 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
635 <CODE>protected void</CODE></FONT></TD>
636 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refreshVolumeNames()">refreshVolumeNames</A></B>()</CODE>
639 Obtains the most current list of volume names of this partition.</TD>
641 <TR BGCOLOR="white" CLASS="TableRowColor">
642 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
643 <CODE>protected void</CODE></FONT></TD>
644 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#refreshVolumes()">refreshVolumes</A></B>()</CODE>
647 Obtains the most current list of <code>Volume</code> objects of this
650 <TR BGCOLOR="white" CLASS="TableRowColor">
651 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
652 <CODE> void</CODE></FONT></TD>
653 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#salvage()">salvage</A></B>()</CODE>
656 Salvages (restores consistency to) this partition. </TD>
658 <TR BGCOLOR="white" CLASS="TableRowColor">
659 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
660 <CODE> void</CODE></FONT></TD>
661 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#syncPartition()">syncPartition</A></B>()</CODE>
664 Syncs this partition to the VLDB.</TD>
666 <TR BGCOLOR="white" CLASS="TableRowColor">
667 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
668 <CODE> void</CODE></FONT></TD>
669 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Partition.html#syncVLDB()">syncVLDB</A></B>()</CODE>
672 Syncs the VLDB to this partition.</TD>
674 <TR BGCOLOR="white" CLASS="TableRowColor">
675 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
676 <CODE> <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>
680 Returns the name of this <CODE>Partition</CODE></TD>
682 <TR BGCOLOR="white" CLASS="TableRowColor">
683 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
684 <CODE>protected static <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 id)</CODE>
688 Translates a partition id into a partition name</TD>
690 <TR BGCOLOR="white" CLASS="TableRowColor">
691 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
692 <CODE>protected static 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> name)</CODE>
696 Translates a partition name into a partition id</TD>
699 <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>
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>
711 <!-- ============ FIELD DETAIL =========== -->
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>
721 <A NAME="cell"><!-- --></A><H3>
724 protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>cell</B></PRE>
731 <A NAME="server"><!-- --></A><H3>
734 protected <A HREF="../../../org/openafs/jafs/Server.html">Server</A> <B>server</B></PRE>
741 <A NAME="name"><!-- --></A><H3>
744 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
751 <A NAME="id"><!-- --></A><H3>
754 protected int <B>id</B></PRE>
761 <A NAME="deviceName"><!-- --></A><H3>
764 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>deviceName</B></PRE>
771 <A NAME="lockFileDescriptor"><!-- --></A><H3>
772 lockFileDescriptor</H3>
774 protected int <B>lockFileDescriptor</B></PRE>
781 <A NAME="totalSpace"><!-- --></A><H3>
784 protected int <B>totalSpace</B></PRE>
791 <A NAME="totalFreeSpace"><!-- --></A><H3>
794 protected int <B>totalFreeSpace</B></PRE>
801 <A NAME="totalQuota"><!-- --></A><H3>
804 protected int <B>totalQuota</B></PRE>
811 <A NAME="volumes"><!-- --></A><H3>
814 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>volumes</B></PRE>
821 <A NAME="volumeNames"><!-- --></A><H3>
824 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>volumeNames</B></PRE>
831 <A NAME="cachedInfo"><!-- --></A><H3>
834 protected boolean <B>cachedInfo</B></PRE>
840 <!-- ========= CONSTRUCTOR DETAIL ======== -->
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>
850 <A NAME="Partition(java.lang.String, org.openafs.jafs.Server)"><!-- --></A><H3>
853 public <B>Partition</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
854 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)
855 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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
867 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
870 <A NAME="Partition(java.lang.String, org.openafs.jafs.Server, boolean)"><!-- --></A><H3>
873 public <B>Partition</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
874 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> server,
875 boolean preloadAllMembers)
876 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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
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.
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>
900 <A NAME="Partition(org.openafs.jafs.Server)"><!-- --></A><H3>
903 <B>Partition</B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)
904 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
910 <DT><B>Parameters:</B><DD><CODE>server</CODE> - the server on which the partition resides
912 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
914 <!-- ============ METHOD DETAIL ========== -->
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>
924 <A NAME="refresh()"><!-- --></A><H3>
927 public void <B>refresh</B>()
928 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
953 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
958 <A NAME="refresh(boolean)"><!-- --></A><H3>
961 protected void <B>refresh</B>(boolean all)
962 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
979 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties; otherwise
980 renew all set properties
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>
987 <A NAME="refreshInfo()"><!-- --></A><H3>
990 protected void <B>refreshInfo</B>()
991 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
993 <DD>Refreshes the information fields of this <code>Partition</code> to
994 reflect the current state of the AFS partition. These include total
1003 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1008 <A NAME="refreshVolumes()"><!-- --></A><H3>
1011 protected void <B>refreshVolumes</B>()
1012 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1014 <DD>Obtains the most current list of <code>Volume</code> objects of this
1023 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1028 <A NAME="refreshVolumeNames()"><!-- --></A><H3>
1029 refreshVolumeNames</H3>
1031 protected void <B>refreshVolumeNames</B>()
1032 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1034 <DD>Obtains the most current list of volume names of this partition.
1042 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1047 <A NAME="syncPartition()"><!-- --></A><H3>
1050 public void <B>syncPartition</B>()
1051 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1053 <DD>Syncs this partition to the VLDB.
1061 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1066 <A NAME="syncVLDB()"><!-- --></A><H3>
1069 public void <B>syncVLDB</B>()
1070 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1072 <DD>Syncs the VLDB to this partition.
1080 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1085 <A NAME="salvage()"><!-- --></A><H3>
1088 public void <B>salvage</B>()
1089 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1091 <DD>Salvages (restores consistency to) this partition. Uses default values for
1092 most salvager options in order to simplify the API.
1100 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1105 <A NAME="getName()"><!-- --></A><H3>
1108 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
1110 <DD>Returns the name of this partition.
1117 <DT><B>Returns:</B><DD>the name of this partition</DL>
1122 <A NAME="getServer()"><!-- --></A><H3>
1125 public <A HREF="../../../org/openafs/jafs/Server.html">Server</A> <B>getServer</B>()</PRE>
1127 <DD>Returns this partition's hosting server.
1134 <DT><B>Returns:</B><DD>this partition's server</DL>
1139 <A NAME="getVolumeCount()"><!-- --></A><H3>
1142 public int <B>getVolumeCount</B>()
1143 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1145 <DD>Returns the number of volumes contained in this partition.
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.
1152 <P> The product of this method is not saved, and is recalculated
1160 <DT><B>Returns:</B><DD>the number of volumes contained in this partition.
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>
1168 <A NAME="getVolume(java.lang.String)"><!-- --></A><H3>
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> name)
1172 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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>.
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>
1195 <A NAME="getVolumes()"><!-- --></A><H3>
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>
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
1214 <DT><B>Returns:</B><DD>a <code>Volume</code> array of the <code>Volume</code>
1215 objects of the partition.
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>
1222 <A NAME="getVolumes(int, int)"><!-- --></A><H3>
1225 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>[] <B>getVolumes</B>(int startIndex,
1227 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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.
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.
1247 <P>This method does not save the resulting data and therefore
1248 queries AFS for each call.
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.
1255 if (partition.getVolumeCount() > 50000) {
1258 while (index < partition.getVolumeCount()) {
1259 volumes = partition.<B>getVolumes</B>(index, length);
1260 for (int i = 0; i < volumes.length; i++) {
1267 volumes = partition.getVolumes();
1268 for (int i = 0; i < volumes.length; i++) {
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
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>
1291 <A NAME="getVolumeNames()"><!-- --></A><H3>
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>
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
1309 <DT><B>Returns:</B><DD>a <code>String</code> array of the volumes of the partition.
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>
1316 <A NAME="getVolumeNames(int, int)"><!-- --></A><H3>
1319 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getVolumeNames</B>(int startIndex,
1321 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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.
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.
1339 <P>This method does not save the resulting data and therefore
1340 queries AFS for each call.
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.
1347 if (partition.getVolumeCount() > 50000) {
1350 while (index < partition.getVolumeCount()) {
1351 volumes = partition.<B>getVolumeNames</B>(index, length);
1352 for (int i = 0; i < volumes.length; i++) {
1359 volumes = partition.getVolumeNames();
1360 for (int i = 0; i < volumes.length; i++) {
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
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>
1383 <A NAME="getID()"><!-- --></A><H3>
1386 public int <B>getID</B>()
1387 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1389 <DD>Returns the id of this partition (i.e. "vicepa" = 0, etc.)
1396 <DT><B>Returns:</B><DD>the id of this partition
1398 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1403 <A NAME="getDeviceName()"><!-- --></A><H3>
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>
1409 <DD>Returns the device name of this partition (i.e. "hda5", etc.)
1416 <DT><B>Returns:</B><DD>the device name of this partition
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>
1423 <A NAME="getLockFileDescriptor()"><!-- --></A><H3>
1424 getLockFileDescriptor</H3>
1426 public int <B>getLockFileDescriptor</B>()
1427 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1429 <DD>Returns the lock file descriptor of this partition
1436 <DT><B>Returns:</B><DD>the lock file descriptor of this partition
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>
1443 <A NAME="getTotalSpace()"><!-- --></A><H3>
1446 public int <B>getTotalSpace</B>()
1447 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1449 <DD>Returns the total space on this partition.
1456 <DT><B>Returns:</B><DD>the total space on this partition
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>
1463 <A NAME="getTotalFreeSpace()"><!-- --></A><H3>
1464 getTotalFreeSpace</H3>
1466 public int <B>getTotalFreeSpace</B>()
1467 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
1480 <DT><B>Returns:</B><DD>the total free space on this partition
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>
1487 <A NAME="getUsedSpace()"><!-- --></A><H3>
1490 public int <B>getUsedSpace</B>()
1491 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
1504 <DT><B>Returns:</B><DD>the total used space on this partition
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>
1511 <A NAME="getTotalQuota()"><!-- --></A><H3>
1514 public int <B>getTotalQuota</B>()
1515 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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.
1530 <DT><B>Returns:</B><DD>the total combined quota of all volumes on this partition
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>
1541 <A NAME="getTotalQuota(boolean)"><!-- --></A><H3>
1544 public int <B>getTotalQuota</B>(boolean ignoreUnlimitedQuotas)
1545 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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.
1561 <DT><B>Returns:</B><DD>the total combined quota of all volumes on this partition
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>
1573 <A NAME="hasVolumeWithUnlimitedQuota()"><!-- --></A><H3>
1574 hasVolumeWithUnlimitedQuota</H3>
1576 public boolean <B>hasVolumeWithUnlimitedQuota</B>()
1577 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1579 <DD>Tests whether this partition contains a volume that has an unlimited
1587 <DT><B>Returns:</B><DD><CODE>true</CODE> if a contained volume's quota is configured
1588 as unlimited; otherwise <CODE>false</CODE>.
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>
1599 <A NAME="getInfo()"><!-- --></A><H3>
1602 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
1604 <DD>Returns a <code>String</code> representation of this
1605 <code>Partition</code>. Contains the information fields and a list of
1613 <DT><B>Returns:</B><DD>a <code>String</code> representation of the <code>Partition</code></DL>
1618 <A NAME="getInfoVolumes()"><!-- --></A><H3>
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>
1624 <DD>Returns a <code>String</code> containing the <code>String</code>
1625 representations of all the volumes of this <code>Partition</code>.
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>
1638 <A NAME="compareTo(org.openafs.jafs.Partition)"><!-- --></A><H3>
1641 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> partition)</PRE>
1643 <DD>Compares two Partition objects respective to their names and does not
1644 factor any other attribute. Alphabetic case is significant in
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>
1662 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
1665 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A> obj)</PRE>
1667 <DD>Comparable interface method.
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>
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>
1678 <A NAME="equals(org.openafs.jafs.Partition)"><!-- --></A><H3>
1681 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> otherPartition)</PRE>
1683 <DD>Tests whether two <code>Partition</code> objects are equal,
1684 based on their names and hosting server.
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>
1696 <A NAME="toString()"><!-- --></A><H3>
1699 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
1701 <DD>Returns the name of this <CODE>Partition</CODE>
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>
1708 <DT><B>Returns:</B><DD>the name of this <CODE>Partition</CODE></DL>
1713 <A NAME="getPartitionInfo(int, int, int, org.openafs.jafs.Partition)"><!-- --></A><H3>
1714 getPartitionInfo</H3>
1716 protected static void <B>getPartitionInfo</B>(int cellHandle,
1717 int serverHandle,
1719 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> thePartition)
1720 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1722 <DD>Fills in the information fields of the provided <code>Partition</code>.
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
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>
1739 <A NAME="getVolumeCount(int, int, int)"><!-- --></A><H3>
1742 protected static int <B>getVolumeCount</B>(int cellHandle,
1743 int serverHandle,
1745 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1747 <DD>Returns the total number of volumes hosted by this partition.
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
1756 <DT><B>Returns:</B><DD>total number of volumes hosted by this partition
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>
1764 <A NAME="getVolumesBegin(int, int, int)"><!-- --></A><H3>
1765 getVolumesBegin</H3>
1767 protected static int <B>getVolumesBegin</B>(int cellHandle,
1768 int serverHandle,
1770 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
1783 <DT><B>Returns:</B><DD>an iteration ID
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>
1791 <A NAME="getVolumesBeginAt(int, int, int, int)"><!-- --></A><H3>
1792 getVolumesBeginAt</H3>
1794 protected static int <B>getVolumesBeginAt</B>(int cellHandle,
1795 int serverHandle,
1798 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
1811 <DT><B>Returns:</B><DD>an iteration ID
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>
1819 <A NAME="getVolumesNextString(int)"><!-- --></A><H3>
1820 getVolumesNextString</H3>
1822 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getVolumesNextString</B>(int iterationId)
1823 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1825 <DD>Returns the next volume of the partition. Returns <code>null</code>
1826 if there are no more volumes.
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
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>
1840 <A NAME="getVolumesNext(int, org.openafs.jafs.Volume)"><!-- --></A><H3>
1843 protected static int <B>getVolumesNext</B>(int iterationId,
1844 <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> theVolume)
1845 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1847 <DD>Fills the next volume object of the partition. Returns 0 if there
1848 are no more volumes, != 0 otherwise.
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
1856 <DT><B>Returns:</B><DD>0 if there are no more volumes, != 0 otherwise
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>
1863 <A NAME="getVolumesAdvanceTo(int, org.openafs.jafs.Volume, int)"><!-- --></A><H3>
1864 getVolumesAdvanceTo</H3>
1866 protected static int <B>getVolumesAdvanceTo</B>(int iterationId,
1867 <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> theVolume,
1868 int advanceCount)
1869 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1871 <DD>Fills the next volume object of the partition. Returns 0 if there
1872 are no more volumes, != 0 otherwise.
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
1880 <DT><B>Returns:</B><DD>0 if there are no more volumes, != 0 otherwise
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>
1887 <A NAME="getVolumesDone(int)"><!-- --></A><H3>
1890 protected static void <B>getVolumesDone</B>(int iterationId)
1891 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1893 <DD>Signals that the iteration is complete and will not be accessed anymore.
1899 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
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>
1906 <A NAME="translateNameToID(java.lang.String)"><!-- --></A><H3>
1907 translateNameToID</H3>
1909 protected static int <B>translateNameToID</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name)
1910 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1912 <DD>Translates a partition name into a partition id
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
1921 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1926 <A NAME="translateIDToName(int)"><!-- --></A><H3>
1927 translateIDToName</H3>
1929 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>translateIDToName</B>(int id)
1930 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1932 <DD>Translates a partition id into a partition name
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
1941 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1946 <A NAME="reclaimPartitionMemory()"><!-- --></A><H3>
1947 reclaimPartitionMemory</H3>
1949 protected static void <B>reclaimPartitionMemory</B>()</PRE>
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
1963 <!-- ========= END OF CLASS DATA ========= -->
1966 <!-- ========== START OF NAVBAR ========== -->
1967 <A NAME="navbar_bottom"><!-- --></A>
1968 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
1975 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1976 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Partition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
1977 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1978 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1979 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1980 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1984 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1985 <B>JAFS API v2</B></EM>
1990 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1991 <A HREF="../../../org/openafs/jafs/Key.html"><B>PREV CLASS</B></A>
1992 <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>
1995 <A HREF="Partition.html" TARGET="_top"><B>NO FRAMES</B></A>
2000 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
2005 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
2010 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2011 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
2012 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2013 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
2016 <!-- =========== END OF NAVBAR =========== -->