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

Interface com.jconfig.FileSystem

Summary

    public interface  FileSystem
         extends com.jconfig.DumpInfo
    {
              // Fields 15
         public static final int FS_GETCAP_CAP_OFFSET;
         public static final int FS_GETCAP_FREESPACE_OFFSET;
         public static final int FS_GETCAP_LENGTH;
         public static final int VOL_CASE_PRESERVED;
         public static final int VOL_CASE_SENSITIVE;
         public static final int VOL_CDROM;
         public static final int VOL_FILES_COMPRESSED;
         public static final int VOL_FIXED;
         public static final int VOL_RAM;
         public static final int VOL_REMOTE;
         public static final int VOL_REMOVABLE;
         public static final int VOL_SYSTEM;
         public static final int VOL_UNICODE;
         public static final int VOL_VOL_COMPRESSED;
         public static final String copyrightString;

              // Methods 8
         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 long getReferenceNumber();
         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-2002 Samizdat Productions. All Rights Reserved.

Cross Reference

Returned By:
  DiskObject.getFileSystem(), FileRegistryI.getFileSystems(), FileRegistryPlain.getFileSystems(), FileRegistry.getFileSystems(), DiskFileMRJ.getFileSystem(), DiskVolumeMRJ.getFileSystem(), FSCreatorMRJ.getFileFileSystem(), FSCreatorMRJ.getFileSystems(), FSCreatorMRJ.getVolumeFileSystem(), FileRegistryMRJ.getFileSystems(), DiskFileNix.getFileSystem(), DiskVolumeNix.getFileSystem(), FSCreatorNix.getFileFileSystem(), FSCreatorNix.getFileSystems(), FSCreatorNix.getVolumeFileSystem(), FileRegistryNix.getFileSystems(), DiskFileMSVM.getFileSystem(), DiskVolumeMSVM.getFileSystem(), FSCreatorMSVM.getFileFileSystem(), FSCreatorMSVM.getFileSystems(), FSCreatorMSVM.getVolumeFileSystem(), FileRegistryMSVM.getFileSystems()

Implemented By:
  FileSystemNix

Fields

### · copyrightString | Summary | Top

       public static final String copyrightString

### · VOL_CASE_PRESERVED | Summary | Top

       public static final int VOL_CASE_PRESERVED

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

### · VOL_CASE_SENSITIVE | Summary | Top

       public static final int VOL_CASE_SENSITIVE

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

### · VOL_UNICODE | Summary | Top

       public static final int VOL_UNICODE

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

### · VOL_FILES_COMPRESSED | Summary | Top

       public static final int VOL_FILES_COMPRESSED

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

### · VOL_VOL_COMPRESSED | Summary | Top

       public static final int VOL_VOL_COMPRESSED

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

### · VOL_REMOVABLE | Summary | Top

       public static final int VOL_REMOVABLE

> Mask used to indicate that this file system is removable.

### · VOL_FIXED | Summary | Top

       public static final int VOL_FIXED

> Mask used to indicate that this file system is fixed.

### · VOL_REMOTE | Summary | Top

       public static final int VOL_REMOTE

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

### · VOL_CDROM | Summary | Top

       public static final int VOL_CDROM

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

### · VOL_RAM | Summary | Top

       public static final int VOL_RAM

> Mask used to indicate that this is a RAM disk.

### · VOL_SYSTEM | Summary | Top

       public static final int VOL_SYSTEM

> Mask used to indicate that this is system disk.

### · FS_GETCAP_LENGTH | Summary | Top

       public static final int FS_GETCAP_LENGTH

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

### · FS_GETCAP_CAP_OFFSET | Summary | Top

       public static final int FS_GETCAP_CAP_OFFSET

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

### · FS_GETCAP_FREESPACE_OFFSET | Summary | Top

       public static final int FS_GETCAP_FREESPACE_OFFSET

> 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 'FS_GETCAP_LENGTH' elements. The capacity of the file system will be stored at offset 'FS_GETCAP_CAP_OFFSET', and the free space will be stored at offset 'FS_GETCAP_FREESPACE_OFFSET'.

### · getMaxFileNameLength | Summary | Top

       public abstract int getMaxFileNameLength()

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

### · getReferenceNumber | Summary | Top

       public abstract long getReferenceNumber()

> Returns the platform-specific number used to uniquely identify this file system. On 'Nix, this is the f_fsid field of the statfs structure returned from fstatfs

    All Packages  This Package  Class Hierarchy  Class Search  Index

Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7