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

Class com.jconfig.win.DiskFileMSVM

    java.lang.Object
       |
       +----com.jconfig.win.DiskFileMSVM

Summary

    class  DiskFileMSVM
         extends java.lang.Object
         implements com.jconfig.DiskFile
    {
              // Fields 7
         private boolean bAlreadyGotVersionInfo;
         private boolean bIsFolder;
         private static final String copyrightString;
         private File theFile;
         private String thePath;
         private DiskVolume theVolume;
         private VersionInfoMSVM versionInfo;

              // Constructors 1
         DiskFileMSVM(File) throws FileNotFoundException, DiskFileException;

              // Methods 32
         public DiskObject createObject(String, int, int);
         public String diskFileFlagsToString(int);
         public void dumpInfo(PrintStream, String);
         public boolean exists();
         public int getColorCoding();
         public DiskObject getContainer() throws FileNotFoundException, DiskFileException;
         public DateBundle getDateBundle();
         protected String getDateString();
         public String getDisplayName();
         public File getFile();
         String getFilePath();
         public long getFileSize();
         public FileSystem getFileSystem();
         public FinderInfo getFinderInfo();
         public int getFlags();
         public int getGetFlagsMask();
         public IconBundle getIconBundle();
         public String getName();
         public int[] getPlatformData();
         public ResourceFork getResourceFork();
         public long getResourceForkSize();
         public int getSetFlagsMask();
         public String getShortName();
         public VersionInfo getVersion();
         public DiskVolume getVolume();
         public int iterate(DiskFilter, int, int);
         private void makeVersionInfo();
         public void setDateBundle(DateBundle);
         public int setFinderInfo(FinderInfo);
         public void setFlags(int, int);
         public int setName(String);
         public int updateContainer();
    }

Represents a disk file.

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

Cross Reference

Extended By:
  AppFileMSVM, DiskAliasMSVM

Fields

### · copyrightString | Summary | Top

       private static final String copyrightString

### · theFile | Summary | Top

       private File theFile

### · thePath | Summary | Top

       private String thePath

### · theVolume | Summary | Top

       private DiskVolume theVolume

### · versionInfo | Summary | Top

       private VersionInfoMSVM versionInfo

### · bIsFolder | Summary | Top

       private boolean bIsFolder

### · bAlreadyGotVersionInfo | Summary | Top

       private boolean bAlreadyGotVersionInfo

Constructors

### · DiskFileMSVM | Summary | Top

       DiskFileMSVM(File fl)  throws FileNotFoundException, DiskFileException

> Construct from a java.io.File object. The file must exist.

Methods

### · getFileSystem | Summary | Top

       public FileSystem getFileSystem()

> Returns the file system containing this object. Calls FSCreatorMSVM.getFileFileSystem().

### · exists | Summary | Top

       public boolean exists()

> Checks whether this file or folder exists.

### · getName | Summary | Top

       public String getName()

> Returns the name. If the file or folder does not exist, returns null.

### · setName | Summary | Top

       public int setName(String newName)

> Renames this file.

### · getDisplayName | Summary | Top

       public String getDisplayName()

> Returns the name as it would be displayed to the user.

### · getShortName | Summary | Top

       public String getShortName()

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

> Implements:
>   getShortName in interface DiskFile

### · getFlags | Summary | Top

       public int getFlags()

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

> Throws: OSException
>   if an OS error occurs

### · getGetFlagsMask | Summary | Top

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

> Throws: OSException
>   if an OS error occurs

### · setFlags | Summary | Top

       public void setFlags(int whichFlags,
                            int newValues)

> Set the indicated flags.

> Parameter | Description
> whichFlags | the mask indicating which bits in newValues are significant
> newValues | contains the bits to be set/reset.

> Throws: OSException
>   if an OS error occurs

### · getSetFlagsMask | Summary | Top

       public int getSetFlagsMask()

> Returns a mask which indicates which bits in the argument to 'setFlags' can be set. For instance, if bit 0 of the return value of this method is set, bit 0 of 'setFlags' can be set.

> Throws: OSException
>   if an OS error occurs

### · getDateBundle | Summary | Top

       public DateBundle getDateBundle()

> Returns a DateBundle containing the creation, modification, and backup dates of this file or folder.

### · setDateBundle | Summary | Top

       public void setDateBundle(DateBundle newDates)

> Sets the set of dates associated with this file.

### · getColorCoding | Summary | Top

       public int getColorCoding()

> Mac-specific. Always returns 0.

### · getFile | Summary | Top

       public File getFile()

> Returns a copy of the java.io.File object used to create this object.

### · getFileSize | Summary | Top

       public long getFileSize()

> Calls the java.io.File.length() method.

> Implements:
>   getFileSize in interface DiskFile

### · getResourceForkSize | Summary | Top

       public long getResourceForkSize()

> Mac-specific. Always returns 0.

> Implements:
>   getResourceForkSize in interface DiskFile

### · getVolume | Summary | Top

       public DiskVolume getVolume()

> Returns the DiskVolumeMSVM containing this object.

> Implements:
>   getVolume in interface DiskFile

### · getVersion | Summary | Top

       public VersionInfo getVersion()

> Returns the version information for this file, if any. The version info is lazily created, and is assumed not to change throughout the life of this object.

> Implements:
>   getVersion in interface DiskFile

### · makeVersionInfo | Summary | Top

       private void makeVersionInfo()

> Create a VersionInfoMSVM object for this file.

### · getPlatformData | Summary | Top

       public int[] getPlatformData()

> Always returns null.

> Implements:
>   getPlatformData in interface DiskFile

### · getFinderInfo | Summary | Top

       public FinderInfo getFinderInfo()

> Mac-specific.

> Throws: UnimplementedException
>   this method always throws an UnimplementedException
> Implements:
>   getFinderInfo in interface DiskFile

### · setFinderInfo | Summary | Top

       public int setFinderInfo(FinderInfo newFI)

> Mac-specific.

> Throws: UnimplementedException
>   this method always throws an UnimplementedException
> Implements:
>   setFinderInfo in interface DiskFile

### · updateContainer | Summary | Top

       public int updateContainer()

> Throws: UnimplementedException
>   this method always throws an UnimplementedException

### · getIconBundle | Summary | Top

       public IconBundle getIconBundle()

> Returns an IconBundle for this file or folder.

### · iterate | Summary | Top

       public int iterate(DiskFilter filter,
                          int flags,
                          int maxToIterate)

> Calls through to a convenience method in AppUtilsMSVM.

### · getContainer | Summary | Top

       public DiskObject getContainer()  throws FileNotFoundException, DiskFileException

> Uses the java.io.File.getParent() method to create a DiskObject.

### · getFilePath | Summary | Top

       String getFilePath()

> Returns the full path of this file.

### · diskFileFlagsToString | Summary | Top

       public String diskFileFlagsToString(int f)

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

> Implements:
>   diskFileFlagsToString in interface DiskFile

### · createObject | Summary | Top

       public DiskObject createObject(String name,
                                      int type,
                                      int flags)

> Used to create a file, folder or other object which will be contained by this DiskObject. Returns the new DiskObject, or null if the object could not be created.

> Parameter | Description
> name | the name of the new object
> type | either 'DO_CREATEFILE' or 'DO_CREATEDIR'
> flags | reserved; set to 0

### · getResourceFork | Summary | Top

       public ResourceFork getResourceFork()

> Not implemented on Windows, always returns null.

> Implements:
>   getResourceFork in interface DiskFile

### · getDateString | Summary | Top

       protected String getDateString()

### · dumpInfo | Summary | Top

       public void dumpInfo(PrintStream ps,
                            String indent)

    All Packages  This Package  Class Hierarchy  Class Search  Index

Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7