All Packages  This Package  Class Hierarchy  Class Search  Index

Interface COM.tolstoy.jconfig.FileSystem

  Summary

public interface  FileSystem
     extends COM.tolstoy.jconfig.DumpInfo
{
          // Fields 15
     public static final String copyrightString;
     public static final int kCDROM;
     public static final int kCaseIsPreserved;
     public static final int kCaseSensitive;
     public static final int kFilesCompressed;
     public static final int kFixed;
     public static final int kGetCapCapacityOffset;
     public static final int kGetCapFreeSpaceOffset;
     public static final int kGetCapLength;
     public static final int kRAM;
     public static final int kRemote;
     public static final int kRemovable;
     public static final int kSystem;
     public static final int kUnicodeSupported;
     public static final int kVolumeCompressed;

          // Methods 7
     public abstract int getCapacity(long[]);
     public abstract String getDisplayName();
     public abstract int getFlags();
     public abstract int getGetFlagsMask();
     public abstract int getMaxFileNameLength();
     public abstract DiskObject getMountPoint();
     public abstract boolean isMatch(FileSystem);
}

Represents a file system. This is a preliminary interface, which will be modified and expanded later.

Author:
Copyright (c) 1997,1998 Samizdat Productions. All Rights Reserved.


  Cross Reference

Returned By:
DiskObject.getFileSystem(), FileRegistryI.getFileSystems(), FileRegistry.getFileSystems()





  Fields

· copyrightString

Summary  |  Top
   public static final String copyrightString


· kCaseIsPreserved

Summary  |  Top
   public static final int kCaseIsPreserved

Mask used to indicate that case is preserved on this file system.


· kCaseSensitive

Summary  |  Top
   public static final int kCaseSensitive

Mask used to indicate that file names used on this file system are case sensitive.


· kUnicodeSupported

Summary  |  Top
   public static final int kUnicodeSupported

Mask used to indicate that this file system supports file names stored with Unicode.


· kFilesCompressed

Summary  |  Top
   public static final int kFilesCompressed

Mask used to indicate that files saved to this file system will be compressed.


· kVolumeCompressed

Summary  |  Top
   public static final int kVolumeCompressed

Mask used to indicate that this file system supports volume-level compression.


· kRemovable

Summary  |  Top
   public static final int kRemovable

Mask used to indicate that this file system is removable.


· kFixed

Summary  |  Top
   public static final int kFixed

Mask used to indicate that this file system is fixed.


· kRemote

Summary  |  Top
   public static final int kRemote

Mask used to indicate that this is a remote file system.


· kCDROM

Summary  |  Top
   public static final int kCDROM

Mask used to indicate that this is a CD-ROM.


· kRAM

Summary  |  Top
   public static final int kRAM

Mask used to indicate that this is a RAM disk.


· kSystem

Summary  |  Top
   public static final int kSystem

Mask used to indicate that this is system disk.


· kGetCapLength

Summary  |  Top
   public static final int kGetCapLength

The minimum length of the 'cap' argument to the 'getCapacity()' method.


· kGetCapCapacityOffset

Summary  |  Top
   public static final int kGetCapCapacityOffset

The minimum length of the 'cap' argument to the 'getCapacity()' method.


· kGetCapFreeSpaceOffset

Summary  |  Top
   public static final int kGetCapFreeSpaceOffset

The minimum length of the 'cap' argument to the 'getCapacity()' method.


  Methods

· isMatch

Summary  |  Top

   public abstract boolean isMatch(FileSystem fs) 

Indicates whether this FileSystem and 'fs' are the same.



· getMountPoint

Summary  |  Top
   public abstract DiskObject getMountPoint() 

Returns a DiskObject representing the point in the directory hierarchy where this file system is mounted. May return null if that information is not available.



· getDisplayName

Summary  |  Top
   public abstract String getDisplayName() 

Returns the name of this object, as it would be displayed to the user. Note that the display name may be different from the name of this object. If this object no longer exists, returns null.



· getFlags

Summary  |  Top
   public abstract int getFlags() 

Returns a set of binary flags associated with this object. Use the 'getGetFlagsMask' method to find out which bits of the returned value are significant.



· getGetFlagsMask

Summary  |  Top
   public abstract 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.



· getCapacity

Summary  |  Top
   public abstract int getCapacity(long[] cap) 

Retrieves the the maximum number of bytes of data this file system can hold, as well as the number of bytes currently available on this file system.

Parameter Description
cap on return from this method, this array will contain the capacity and free space. It must have at least 'kGetCapLength' elements. The capacity of the file system will be stored at offset 'kGetCapCapacityOffset', and the free space will be stored at offset 'kGetCapFreeSpaceOffset'.



· getMaxFileNameLength

Summary  |  Top
   public abstract int getMaxFileNameLength() 

Returns the maximum length each element of a path name can have.



All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7