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.mac.DiskVolumeMRJ

    java.lang.Object
       |
       +----com.jconfig.mac.DiskVolumeMRJ

Summary

    class  DiskVolumeMRJ
         extends java.lang.Object
         implements com.jconfig.DiskVolume,
                    com.jconfig.mac.IMacDiskObject
    {
              // Fields 3
         private boolean bExists;
         private static final String copyrightString;
         private int vRef;

              // Constructors 1
         DiskVolumeMRJ(int);

              // Methods 31
         public DiskObject createObject(String, int, int);
         private String diskVolumeFlagsToString(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();
         public FileSystem getFileSystem();
         public int getFlags();
         public long getFreeSpace();
         public int getGetFlagsMask();
         public IconBundle getIconBundle();
         public long getMaxCapacity();
         public int getMaxFileNameLength();
         public String getName();
         public byte[] getPName();
         public int getParID();
         public String getPrefix();
         public long getReferenceNumber();
         public int getSetFlagsMask();
         public int getVRef();
         public int iterate(DiskFilter, int, int);
         public int setColorCoding(int);
         public void setDateBundle(DateBundle);
         public void setFlags(int, int);
         public int setIconBundle(IconBundle);
         public int setName(String);
         public int updateContainer();
    }

Represents a Mac disk drive.

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

Fields

### · copyrightString | Summary | Top

       private static final String copyrightString

### · vRef | Summary | Top

       private int vRef

### · bExists | Summary | Top

       private boolean bExists

Constructors

### · DiskVolumeMRJ | Summary | Top

       DiskVolumeMRJ(int ref)

Methods

### · getFileSystem | Summary | Top

       public FileSystem getFileSystem()

> Returns the file system containing this object. Calls FSCreatorMRJ.getVolumeFileSystem().

### · getName | Summary | Top

       public String getName()

> Returns the name of this volume in quoted-printable format.

### · getVRef | Summary | Top

       public int getVRef()

> Returns the vRefNum.

> Implements:
>   getVRef in interface IMacDiskObject

### · getParID | Summary | Top

       public int getParID()

> Returns the parID, in this case the number 1 (fsRtParID).

> Implements:
>   getParID in interface IMacDiskObject

### · getPName | Summary | Top

       public byte[] getPName()

> Returns a copy of the name as a Pascal string.

> Implements:
>   getPName in interface IMacDiskObject

### · setName | Summary | Top

       public int setName(String newName)

> Renames this volume.

### · getDisplayName | Summary | Top

       public String getDisplayName()

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

### · exists | Summary | Top

       public boolean exists()

> Checks whether this volume is still mounted

### · getFlags | Summary | Top

       public int getFlags()

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

### · 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: IllegalArgumentException
>   if whichFlags is 0
> 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.

### · 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.

### · getDateBundle | Summary | Top

       public DateBundle getDateBundle()

> Returns a DateBundle containing the creation, modification, and backup dates of this volume.

### · setDateBundle | Summary | Top

       public void setDateBundle(DateBundle newDates)

> Sets the set of dates associated with this volume.

### · getIconBundle | Summary | Top

       public IconBundle getIconBundle()

> Returns an IconBundle for this volume.

### · setIconBundle | Summary | Top

       public int setIconBundle(IconBundle bndl)

> Not yet implemented.

> Throws: UnimplementedException
>   this method always throws an UnimplementedException

### · getColorCoding | Summary | Top

       public int getColorCoding()

> Returns the color coding of this object.

### · setColorCoding | Summary | Top

       public int setColorCoding(int newCoding)

> Sets the color coding of this object.

### · getFile | Summary | Top

       public File getFile()

> Returns a java.io.File object created from the name of this volume. Returns null if an error occurs.

### · getPrefix | Summary | Top

       public String getPrefix()

> Returns the prefix, which can be used in constructing full path names: "/Blossom/"

> Implements:
>   getPrefix in interface DiskVolume

### · getMaxFileNameLength | Summary | Top

       public int getMaxFileNameLength()

> Currently, always returns 31.

> Implements:
>   getMaxFileNameLength in interface DiskVolume

### · getReferenceNumber | Summary | Top

       public long getReferenceNumber()

> Returns the vRefNum.

> Implements:
>   getReferenceNumber in interface DiskVolume

### · getMaxCapacity | Summary | Top

       public long getMaxCapacity()

> Returns the max bytes this volume can hold, or 0 if an error occurs.

> Implements:
>   getMaxCapacity in interface DiskVolume

### · getFreeSpace | Summary | Top

       public long getFreeSpace()

> Returns the free space on this volume, or 0 if an error occurs.

> Implements:
>   getFreeSpace in interface DiskVolume

### · updateContainer | Summary | Top

       public int updateContainer()

> Not yet implemented.

### · iterate | Summary | Top

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

> Calls the DiskFilter's visit() method with each file or folder at the top level of this volume. Calls FileIteratorMRJ.iterateVolume().

### · getContainer | Summary | Top

       public DiskObject getContainer()  throws FileNotFoundException, DiskFileException

> Always returns null.

### · createObject | Summary | Top

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

> Not yet implemented; returns null.

### · diskVolumeFlagsToString | Summary | Top

       private String diskVolumeFlagsToString(int f)

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

### · 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