Interface COM.tolstoy.jconfig.DiskFile
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface COM.tolstoy.jconfig.DiskFile

public interface DiskFile
extends Object
extends DiskObject
Represents a file.

Variable Index

 o copyrightString
 o kFInfoCreatorOffset
Offset to the creator value for the getFinderInfo and setFinderInfo methods.
 o kFInfoLen
Length of the array argument to the getFinderInfo method.
 o kFInfoTypeOffset
Offset to the type value for the getFinderInfo and setFinderInfo methods.
 o kHasCustomIcon
Mask used to indicate that this file/directory has a custom icon.
 o kIsDirectory
Mask used to indicate that this is a directory.
 o kIsExecutable
Mask used to indicate that this file is an executable.
 o kIsHidden
Mask used to indicate that this file/directory is hidden.
 o kIsNameLocked
Mask used to indicate that the name of this file/directory cannot be changed.
 o kIsStationery
Mask used to indicate that this file is a stationery form.

Method Index

 o diskFileFlagsToString(int)
Convenience method which converts a given set of DiskFile flags into a string representation.
 o getFileSize()
Returns the length of this file.
 o getFinderInfo(int[])
Retrieves the FinderInfo associated with this file.
 o getPlatformData()
Retrieves platform-specific data for this file.
 o getResourceForkSize()
Returns the size of this file's resource fork, if any.
 o getVersion()
Returns the VersionInfo object which is associated with this file.
 o getVolume()
Returns the DiskVolume object which contains this file or directory.
 o setFinderInfo(int[])
Sets the FinderInfo of this file.

Variables

 o copyrightString
  public final static String copyrightString
 o kIsExecutable
  public final static int kIsExecutable
Mask used to indicate that this file is an executable.
 o kIsDirectory
  public final static int kIsDirectory
Mask used to indicate that this is a directory.
 o kIsHidden
  public final static int kIsHidden
Mask used to indicate that this file/directory is hidden.
 o kIsStationery
  public final static int kIsStationery
Mask used to indicate that this file is a stationery form.
 o kIsNameLocked
  public final static int kIsNameLocked
Mask used to indicate that the name of this file/directory cannot be changed.
 o kHasCustomIcon
  public final static int kHasCustomIcon
Mask used to indicate that this file/directory has a custom icon.
 o kFInfoLen
  public final static int kFInfoLen
Length of the array argument to the getFinderInfo method.
 o kFInfoCreatorOffset
  public final static int kFInfoCreatorOffset
Offset to the creator value for the getFinderInfo and setFinderInfo methods.
 o kFInfoTypeOffset
  public final static int kFInfoTypeOffset
Offset to the type value for the getFinderInfo and setFinderInfo methods.

Methods

 o getFileSize
  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.
 o getResourceForkSize
  public abstract long getResourceForkSize()
Returns the size of this file's resource fork, if any. On Windows, zero is returned.
 o getVolume
  public abstract DiskVolume getVolume()
Returns the DiskVolume object which contains this file or directory.
 o getVersion
  public abstract VersionInfo getVersion()
Returns the VersionInfo object which is associated with this file. Returns null if no version information is available.
 o getPlatformData
  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.
 o getFinderInfo
  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.
Parameters:
info - an array with length >= the kFInfoLen constant
 o setFinderInfo
  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.
Parameters:
info - an array with length >= the kFInfoLen constant
 o diskFileFlagsToString
  public abstract String diskFileFlagsToString(int f)
Convenience method which converts a given set of DiskFile flags into a string representation.

All Packages  Class Hierarchy  This Package  Previous  Next  Index