KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > configuration > IVolume


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.update.configuration;
12
13 import java.io.File JavaDoc;
14
15 import org.eclipse.core.runtime.IAdaptable;
16
17 /**
18  * Local Volume Info.
19  * Represents local file system information for a specific volume.
20  * <p>
21  * This interface is not intended to be implemented by clients.
22  * </p>
23  * <p>
24  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
25  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
26  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
27  * (repeatedly) as the API evolves.
28  * </p>
29  * @see org.eclipse.update.configuration.LocalSystemInfo
30  * @since 2.0
31  */
32 public interface IVolume extends IAdaptable {
33
34     /**
35      * Returns the available free space on this volume.
36      * Returns the amount of free space available to this
37      * user on the volume. The
38      * method takes into account any space quotas or other
39      * native mechanisms that may restrict space usage
40      * on a given volume.
41      * @return the amount of free space available (in units
42      * of Kbyte), or an indication the size is not known
43      * @see LocalSystemInfo#SIZE_UNKNOWN
44      * @since 2.0
45      * <p>
46      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
47      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
48      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
49      * (repeatedly) as the API evolves.
50      * </p>
51      */
52     public long getFreeSpace();
53     
54     /**
55      * returns volume label.
56      * Returns the label of the volume.
57      * @return volume label (as string), or <code>null</code> if
58      * the label cannot be determined.
59      * @since 2.0
60      * <p>
61      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
62      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
63      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
64      * (repeatedly) as the API evolves.
65      * </p>
66      */
67     public String JavaDoc getLabel();
68     
69     /**
70      * Returns volume type.
71      * Returns the type of the volume.
72      * @return volume type
73      * @see LocalSystemInfo#VOLUME_UNKNOWN
74      * @see LocalSystemInfo#VOLUME_INVALID_PATH
75      * @see LocalSystemInfo#VOLUME_REMOVABLE
76      * @see LocalSystemInfo#VOLUME_FIXED
77      * @see LocalSystemInfo#VOLUME_REMOTE
78      * @see LocalSystemInfo#VOLUME_CDROM
79      * @see LocalSystemInfo#VOLUME_FLOPPY_3
80      * @see LocalSystemInfo#VOLUME_FLOPPY_5
81      * @since 2.0
82      * <p>
83      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
84      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
85      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
86      * (repeatedly) as the API evolves.
87      * </p>
88      */
89     public int getType();
90     
91     /**
92      * Returns the volume path.
93      * Returns the path that represents the mount point of the volume.
94      * @return mount point file
95      * @since 2.0
96      * <p>
97      * <b>Note:</b> This method is part of an interim API that is still under development and expected to
98      * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
99      * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
100      * (repeatedly) as the API evolves.
101      * </p>
102      */
103     public File JavaDoc getFile();
104 }
105
Popular Tags