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.nix.DiskVolumeNix

    java.lang.Object
       |
       +----com.jconfig.nix.DiskVolumeNix

Summary

    class  DiskVolumeNix
         extends java.lang.Object
         implements com.jconfig.DiskVolume
    {
              // Fields 2
         private static final String copyrightString;
         private String driveName;

              // Constructors 1
         DiskVolumeNix(String);

              // Methods 27
         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();
         String getDriveName();
         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 String getPrefix();
         public long getReferenceNumber();
         public int getSetFlagsMask();
         public int iterate(DiskFilter, int, int);
         public void setDateBundle(DateBundle);
         public void setFlags(int, int);
         public int setName(String);
         public int updateContainer();
    }

This is a preliminary class derived from the Windows class of similar name. This class may be replaced or modified in a future version.

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

Fields

### · copyrightString | Summary | Top

       private static final String copyrightString

### · driveName | Summary | Top

       private String driveName

Constructors

### · DiskVolumeNix | Summary | Top

       DiskVolumeNix(String s)

Methods

### · getFileSystem | Summary | Top

       public FileSystem getFileSystem()

### · getName | Summary | Top

       public String getName()

### · setName | Summary | Top

       public int setName(String newLabel)

> Throws: UnimplementedException
>   this method always throws an UnimplementedException

### · getDisplayName | Summary | Top

       public String getDisplayName()

### · getPrefix | Summary | Top

       public String getPrefix()

> Implements:
>   getPrefix in interface DiskVolume

### · getDriveName | Summary | Top

       String getDriveName()

### · exists | Summary | Top

       public boolean exists()

### · getFlags | Summary | Top

       public int getFlags()

### · getGetFlagsMask | Summary | Top

       public int getGetFlagsMask()

### · 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: UnimplementedException
>   this method always throws an UnimplementedException

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

> Returns:
>   currently, always returns 0

### · getDateBundle | Summary | Top

       public DateBundle getDateBundle()

### · setDateBundle | Summary | Top

       public void setDateBundle(DateBundle newDates)

> Sets the set of dates associated with this file.

> Parameter | Description
> newDates | if one or more of the dates in this bundle are null, they will not be changed.

### · getColorCoding | Summary | Top

       public int getColorCoding()

### · getFile | Summary | Top

       public File getFile()

### · getMaxFileNameLength | Summary | Top

       public int getMaxFileNameLength()

> Implements:
>   getMaxFileNameLength in interface DiskVolume

### · getReferenceNumber | Summary | Top

       public long getReferenceNumber()

> Implements:
>   getReferenceNumber in interface DiskVolume

### · getMaxCapacity | Summary | Top

       public long getMaxCapacity()

> Implements:
>   getMaxCapacity in interface DiskVolume

### · getFreeSpace | Summary | Top

       public long getFreeSpace()

> Implements:
>   getFreeSpace in interface DiskVolume

### · updateContainer | Summary | Top

       public int updateContainer()

> Throws: UnimplementedException
>   this method always throws an UnimplementedException

### · getIconBundle | Summary | Top

       public IconBundle getIconBundle()

### · iterate | Summary | Top

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

### · getContainer | Summary | Top

       public DiskObject getContainer()  throws FileNotFoundException, DiskFileException

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

### · diskVolumeFlagsToString | Summary | Top

       private String diskVolumeFlagsToString(int f)

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