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.DiskFile

  Summary

public interface  DiskFile
     extends com.jconfig.DiskObject
{
          // Fields 22
     public static final int FILE_ARCHIVE;
     public static final int FILE_BEEN_INITED;
     public static final int FILE_COMPRESSED;
     public static final int FILE_CUSTOM_ICON;
     public static final int FILE_DEVICE;
     public static final int FILE_DIR;
     public static final int FILE_ENCRYPTED;
     public static final int FILE_EXECUTABLE;
     public static final int FILE_HAS_BNDL;
     public static final int FILE_HIDDEN;
     public static final int FILE_NAME_LOCKED;
     public static final int FILE_NOT_CONTENT_INDEXED;
     public static final int FILE_NO_INITS;
     public static final int FILE_OFFLINE;
     public static final int FILE_READONLY;
     public static final int FILE_REPARSEPOINT;
     public static final int FILE_SHARED;
     public static final int FILE_SPARSE;
     public static final int FILE_STATIONERY;
     public static final int FILE_SYSTEM;
     public static final int FILE_TEMP;
     public static final String copyrightString;

          // Methods 10
     public abstract String diskFileFlagsToString(int);
     public abstract long getFileSize();
     public abstract FinderInfo getFinderInfo();
     public abstract int[] getPlatformData();
     public abstract ResourceFork getResourceFork();
     public abstract long getResourceForkSize();
     public abstract String getShortName();
     public abstract VersionInfo getVersion();
     public abstract DiskVolume getVolume();
     public abstract int setFinderInfo(FinderInfo);
}

Represents a file.

Author:
Copyright (c) 1997-2002 Samizdat Productions. All Rights Reserved.


  Cross Reference

Extended By:
AppFile, DiskAlias

Returned By:
ResourceFork.getDiskFile(), ResourceForkMRJ.getDiskFile()

Implemented By:
DiskFileMRJ, DiskFileNix, DiskFileMSVM





  Fields

· copyrightString

Summary  |  Top
   public static final String copyrightString


· FILE_EXECUTABLE

Summary  |  Top
   public static final int FILE_EXECUTABLE

See the file types table in overview.html


· FILE_DIR

Summary  |  Top
   public static final int FILE_DIR

See the file types table in overview.html


· FILE_HIDDEN

Summary  |  Top
   public static final int FILE_HIDDEN

See the file types table in overview.html


· FILE_STATIONERY

Summary  |  Top
   public static final int FILE_STATIONERY

See the file types table in overview.html


· FILE_HAS_BNDL

Summary  |  Top
   public static final int FILE_HAS_BNDL

See the file types table in overview.html


· FILE_BEEN_INITED

Summary  |  Top
   public static final int FILE_BEEN_INITED

See the file types table in overview.html


· FILE_NO_INITS

Summary  |  Top
   public static final int FILE_NO_INITS

See the file types table in overview.html


· FILE_SHARED

Summary  |  Top
   public static final int FILE_SHARED

See the file types table in overview.html


· FILE_NAME_LOCKED

Summary  |  Top
   public static final int FILE_NAME_LOCKED

See the file types table in overview.html


· FILE_CUSTOM_ICON

Summary  |  Top
   public static final int FILE_CUSTOM_ICON

See the file types table in overview.html


· FILE_SYSTEM

Summary  |  Top
   public static final int FILE_SYSTEM

See the file types table in overview.html


· FILE_ARCHIVE

Summary  |  Top
   public static final int FILE_ARCHIVE

See the file types table in overview.html


· FILE_DEVICE

Summary  |  Top
   public static final int FILE_DEVICE

See the file types table in overview.html


· FILE_TEMP

Summary  |  Top
   public static final int FILE_TEMP

See the file types table in overview.html


· FILE_SPARSE

Summary  |  Top
   public static final int FILE_SPARSE

See the file types table in overview.html


· FILE_REPARSEPOINT

Summary  |  Top
   public static final int FILE_REPARSEPOINT

See the file types table in overview.html


· FILE_COMPRESSED

Summary  |  Top
   public static final int FILE_COMPRESSED

See the file types table in overview.html


· FILE_OFFLINE

Summary  |  Top
   public static final int FILE_OFFLINE

See the file types table in overview.html


· FILE_NOT_CONTENT_INDEXED

Summary  |  Top
   public static final int FILE_NOT_CONTENT_INDEXED

See the file types table in overview.html


· FILE_ENCRYPTED

Summary  |  Top
   public static final int FILE_ENCRYPTED

See the file types table in overview.html


· FILE_READONLY

Summary  |  Top
   public static final int FILE_READONLY

See the file types table in overview.html.


  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 FinderInfo getFinderInfo() 

Retrieves the FinderInfo associated with this file. Returns null or throws an exception if an error occurs.

Returns:
a value containing the creator and file type of this file.


· setFinderInfo

Summary  |  Top
   public abstract int setFinderInfo(FinderInfo newFI) 

Sets the FinderInfo of this file. 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.



· getShortName

Summary  |  Top
   public abstract String getShortName() 

Returns the the short version of the file's name, if applicable



· diskFileFlagsToString

Summary  |  Top
   public abstract String diskFileFlagsToString(int f) 

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



· getResourceFork

Summary  |  Top
   public abstract ResourceFork getResourceFork() 

Returns the ResourceFork object for this file. Only valid on Mac; on other platforms, returns null.



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