All Packages  This Package  Class Hierarchy  Class Search  Index

Interface COM.tolstoy.jconfig.DiskFile

  Summary

public interface  DiskFile
     extends COM.tolstoy.jconfig.DiskObject
{
          // Fields 12
     public static final String copyrightString;
     public static final int kFInfoAttribOffset;
     public static final int kFInfoCreatorOffset;
     public static final int kFInfoFlagsOffset;
     public static final int kFInfoLen;
     public static final int kFInfoTypeOffset;
     public static final int kHasCustomIcon;
     public static final int kIsDirectory;
     public static final int kIsExecutable;
     public static final int kIsHidden;
     public static final int kIsNameLocked;
     public static final int kIsStationery;

          // Methods 8
     public abstract String diskFileFlagsToString(int);
     public abstract long getFileSize();
     public abstract int getFinderInfo(int[]);
     public abstract int[] getPlatformData();
     public abstract long getResourceForkSize();
     public abstract VersionInfo getVersion();
     public abstract DiskVolume getVolume();
     public abstract int setFinderInfo(int[]);
}

Represents a file.

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


  Cross Reference

Extended By:
AppFile, DiskAlias





  Fields

· copyrightString

Summary  |  Top
   public static final String copyrightString


· kIsExecutable

Summary  |  Top
   public static final int kIsExecutable

Mask used to indicate that this file is an executable.


· kIsDirectory

Summary  |  Top
   public static final int kIsDirectory

Mask used to indicate that this is a directory.


· kIsHidden

Summary  |  Top
   public static final int kIsHidden

Mask used to indicate that this file/directory is hidden.


· kIsStationery

Summary  |  Top
   public static final int kIsStationery

Mask used to indicate that this file is a stationery form.


· kIsNameLocked

Summary  |  Top
   public static final int kIsNameLocked

Mask used to indicate that the name of this file/directory cannot be changed.


· kHasCustomIcon

Summary  |  Top
   public static final int kHasCustomIcon

Mask used to indicate that this file/directory has a custom icon.


· kFInfoLen

Summary  |  Top
   public static final int kFInfoLen

Length of the array argument to the getFinderInfo method.


· kFInfoCreatorOffset

Summary  |  Top
   public static final int kFInfoCreatorOffset

Offset to the creator value for the getFinderInfo and setFinderInfo methods.


· kFInfoTypeOffset

Summary  |  Top
   public static final int kFInfoTypeOffset

Offset to the type value for the getFinderInfo and setFinderInfo methods.


· kFInfoFlagsOffset

Summary  |  Top
   public static final int kFInfoFlagsOffset

Offset to the flag value for the getFinderInfo and setFinderInfo methods.


· kFInfoAttribOffset

Summary  |  Top
   public static final int kFInfoAttribOffset

Offset to the attributes value for the getFinderInfo and setFinderInfo methods.


  Methods

· getFileSize

Summary  |  Top

   public abstract long getFileSize() 

Returns the length of this file. Note that on Mac, this includes both forks. If this object is a directory, or if an error occurs, 0 is returned.



· getResourceForkSize

Summary  |  Top
   public abstract long getResourceForkSize() 

Returns the size of this file's resource fork, if any. On Windows, zero is returned.



· getVolume

Summary  |  Top
   public abstract DiskVolume getVolume() 

Returns the DiskVolume object which contains this file or directory.



· getVersion

Summary  |  Top
   public abstract VersionInfo getVersion() 

Returns the VersionInfo object which is associated with this file. Returns null if no version information is available.



· getPlatformData

Summary  |  Top
   public abstract int[] getPlatformData() 

Retrieves platform-specific data for this file. On Mac, the vRef is at offset 0, and the parID is at offset 1.



· getFinderInfo

Summary  |  Top
   public abstract int getFinderInfo(int[] info) 

Retrieves the FinderInfo associated with this file. This is Mac-specific; the FinderInfo is the creator and file type of this file. Returns zero if no error occured; non-zero otherwise.

Parameter Description
info an array with length >= the kFInfoLen constant



· setFinderInfo

Summary  |  Top
   public abstract int setFinderInfo(int[] newInfo) 

Sets the FinderInfo of this file. This is Mac-specific; the FinderInfo is the creator and file type of this file. This only works for files, not directories. Returns zero if no error occured; non-zero otherwise.

Parameter Description
info an array with length >= the kFInfoLen constant



· diskFileFlagsToString

Summary  |  Top
   public abstract String diskFileFlagsToString(int f) 

Convenience method which converts a given set of DiskFile flags into a string representation.



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