Main Page
Cookbook/Overview ImageMeister the jcprops file Licensing Binary Installation & Configuration [ Win · Mac · Nix · OSX ] Changes Public API Source Code Main Page Java [ Common · Win · Mac · Nix ] Native Code [ Common · Win · Mac · Nix ] Manifest Native Code Overviews [ Common · Win · Mac · Nix · Strings ] Macros [ General · Native Macros ] Walkthroughs [ Java only · Java and native ] Building [ Win · Mac · Nix · OSX ] Distribution Issues |
All Packages This Package Class Hierarchy Class Search Index
java.lang.Object | +----com.jconfig.win.DiskVolumeMSVM
Summary |
class DiskVolumeMSVM extends java.lang.Object implements com.jconfig.DiskVolume { // Fields 2 private static final String copyrightString; private String driveName; // Constructors 1 DiskVolumeMSVM(String); // Methods 27 public DiskObject createObject(String, int, int); private String diskVolumeFlagsToString(int); public void dumpInfo(PrintStream, String); public boolean exists(); public int getColorCoding(); public DiskObject getContainer() throws FileNotFoundException, DiskFileException; public DateBundle getDateBundle(); protected String getDateString(); public String getDisplayName(); String getDriveName(); public File getFile(); public FileSystem getFileSystem(); public int getFlags(); public long getFreeSpace(); public int getGetFlagsMask(); public IconBundle getIconBundle(); public long getMaxCapacity(); public int getMaxFileNameLength(); public String getName(); public String getPrefix(); public long getReferenceNumber(); public int getSetFlagsMask(); public int iterate(DiskFilter, int, int); public void setDateBundle(DateBundle); public void setFlags(int, int); public int setName(String); public int updateContainer(); }
Represents a DiskVolume on Windows.
Fields |
· copyrightString | Summary | Top |
private static final String copyrightString
· driveName | Summary | Top |
private String driveName
Constructors |
· DiskVolumeMSVM | Summary | Top |
DiskVolumeMSVM(String s)
's' is the drive name, i.e., 'c:\'
Methods |
· getFileSystem | Summary | Top |
public FileSystem getFileSystem()
Returns the file system containing this object. Calls FSCreatorMSVM.getVolumeFileSystem().
· getName | Summary | Top |
public String getName()
Returns the volume label.
· setName | Summary | Top |
public int setName(String newLabel)
Sets the volume label.
· getDisplayName | Summary | Top |
public String getDisplayName()
Returns the name as it would be displayed to the user.
· getPrefix | Summary | Top |
public String getPrefix()
Returns the drive name, e.g., "c:\"
- Implements:
- getPrefix in interface DiskVolume
· getDriveName | Summary | Top |
String getDriveName()
Returns the drive name, e.g., "c:\"
· exists | Summary | Top |
public boolean exists()
Checks whether this volume is still mounted
· getFlags | Summary | Top |
public int getFlags()
Returns a set of binary flags associated with this object. These flags are defined in DiskVolume.java. Use the 'getGetFlagsMask' method to find out which bits of the returned value are significant.
· getGetFlagsMask | Summary | Top |
public int getGetFlagsMask()
Returns a mask which indicates which bits returned by 'getFlags' are significant. For instance, if bit 0 of the return value of this method is set, bit 0 of 'getFlags' contains actual information, otherwise, this information is not available.
· setFlags | Summary | Top |
public void setFlags(int whichFlags, int newValues)
Set the indicated flags.
Parameter Description whichFlags the mask indicating which bits in newValues are significant newValues contains the bits to be set/reset.
- Throws: UnimplementedException
- this method always throws an UnimplementedException
· getSetFlagsMask | Summary | Top |
public int getSetFlagsMask()
Returns a mask which indicates which bits in the argument to 'setFlags' can be set. For instance, if bit 0 of the return value of this method is set, bit 0 of 'setFlags' can be set.
- Returns:
- currently, always returns 0
· getDateBundle | Summary | Top |
public DateBundle getDateBundle()
Returns a DateBundle containing the creation, modification, and backup dates of this volume.
· setDateBundle | Summary | Top |
public void setDateBundle(DateBundle newDates)
Sets the set of dates associated with this volume.
· getColorCoding | Summary | Top |
public int getColorCoding()
· getFile | Summary | Top |
public File getFile()
· getMaxFileNameLength | Summary | Top |
public int getMaxFileNameLength()
Returns the maximum length of a file name component.
- Implements:
- getMaxFileNameLength in interface DiskVolume
· getReferenceNumber | Summary | Top |
public long getReferenceNumber()
Returns the volume serial number
- Implements:
- getReferenceNumber in interface DiskVolume
· getMaxCapacity | Summary | Top |
public long getMaxCapacity()
Returns the max bytes this volume can hold, or 0 if an error occurs.
- Implements:
- getMaxCapacity in interface DiskVolume
· getFreeSpace | Summary | Top |
public long getFreeSpace()
Returns the free space on this volume, or 0 if an error occurs.
- Implements:
- getFreeSpace in interface DiskVolume
· updateContainer | Summary | Top |
public int updateContainer()
Not yet implemented.
- Throws: UnimplementedException
- this method always throws an UnimplementedException
· getIconBundle | Summary | Top |
public IconBundle getIconBundle()
Returns an IconBundle for this volume.
· iterate | Summary | Top |
public int iterate(DiskFilter filter, int flags, int maxToIterate)
Calls the DiskFilter's visit() method with each file or folder at the top level of this volume.
· getContainer | Summary | Top |
public DiskObject getContainer() throws FileNotFoundException, DiskFileException
Always returns null.
· createObject | Summary | Top |
public DiskObject createObject(String name, int type, int flags)
Used to create a file, folder or other object which will be contained by this DiskObject. Returns the new DiskObject, or null if the object could not be created.
Parameter Description name the name of the new object type either 'DO_CREATEFILE' or 'DO_CREATEDIR' flags reserved; set to 0
· diskVolumeFlagsToString | Summary | Top |
private String diskVolumeFlagsToString(int f)
Convenience method which converts a given set of DiskVolume flags into a string representation.
· getDateString | Summary | Top |
protected String getDateString()
· dumpInfo | Summary | Top |
public void dumpInfo(PrintStream ps, String indent)
All Packages This Package Class Hierarchy Class Search IndexFreshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7