Package com.webcodepro.applecommander.storage.os.pascal

Class PascalFormatDisk

java.lang.Object
com.webcodepro.applecommander.storage.FormattedDisk
com.webcodepro.applecommander.storage.os.pascal.PascalFormatDisk
All Implemented Interfaces:
DirectoryEntry, Container
public class PascalFormatDisk extends FormattedDisk
Manages a disk that is in the Pascal format.

Date created: Oct 4, 2002 11:56:50 PM

  • Field Details

    • ENTRY_SIZE

      public static final int ENTRY_SIZE
      The size of the Pascal file entry.
      See Also:

  • Constructor Details

    • PascalFormatDisk

      public PascalFormatDisk(String filename, BlockDevice device)
      Constructor for PascalFormatDisk.

  • Method Details

    • create

      public static PascalFormatDisk[] create(String filename, String volumeName, BlockDevice device)
      Create a PascalFormatDisk.

    • readBlock

      protected byte[] readBlock(int block)

    • writeBlock

      protected void writeBlock(int block, byte[] data)

    • get

      public <T> Optional<T> get(Class<T> iface)

    • getFormat

      public String getFormat()
      Identify the operating system format of this disk.
      Specified by:
      getFormat in class FormattedDisk
      See Also:

    • getFiles

      public List<FileEntry> getFiles()
      Retrieve a list of files.
      See Also:

    • getDirectory

      public List<PascalFileEntry> getDirectory()
      Retrieve the entire directory.

    • putDirectory

      public void putDirectory(List<PascalFileEntry> files)
      Write the revised directory.

    • createFile

      public PascalFileEntry createFile() throws DiskFullException
      Create a new FileEntry.
      Throws:
      DiskFullException

    • canCreateDirectories

      public boolean canCreateDirectories()
      Identify if additional directories can be created. This may indicate that directories are not available to this operating system or simply that the disk image is "locked" to writing.

    • canCreateFile

      public boolean canCreateFile()
      Indicates if this disk image can create a file. If not, the reason may be as simple as it has not beem implemented to something specific about the disk.

    • readDirectory

      public byte[] readDirectory()
      Read directory blocks. These are always in blocks 2 - 5 and are treated as a 2048 byte array.

    • writeDirectory

      public void writeDirectory(byte[] directory)
      Write directory blocks.

    • canHaveDirectories

      public boolean canHaveDirectories()
      Identify if this disk format is capable of having directories.
      Specified by:
      canHaveDirectories in class FormattedDisk
      See Also:

    • getFreeSpace

      public int getFreeSpace()
      Return the amount of free space in bytes.
      Specified by:
      getFreeSpace in class FormattedDisk
      See Also:

    • getFreeBlocks

      public int getFreeBlocks()
      Return the number of free blocks.

    • getVolumeEntry

      protected byte[] getVolumeEntry()
      Return the volume entry.

    • getBlocksOnDisk

      public int getBlocksOnDisk()
      Return the number of blocks on disk.

    • getFilesOnDisk

      public int getFilesOnDisk()
      Return the number of files on disk.

    • getFirstBlock

      public int getFirstBlock()
      Return the first block.

    • getLastAccessDate

      public Date getLastAccessDate()
      Return the last access date.

    • getMostRecentDateSetting

      public Date getMostRecentDateSetting()
      Return the most recent date setting. Huh?

    • getUsedSpace

      public int getUsedSpace()
      Return the amount of used space in bytes.
      Specified by:
      getUsedSpace in class FormattedDisk
      See Also:

    • getUsedBlocks

      public int getUsedBlocks()
      Return the number of used blocks.

    • getDiskName

      public String getDiskName()
      Return the name of the disk. This is stored on block #2 offset +6 (string[7]).
      Specified by:
      getDiskName in class FormattedDisk
      See Also:

    • setDiskName

      public void setDiskName(String volumeName)
      Set the name of the disk. The Pascal parlance is "volume name" whereas AppleCommander uses disk name. Max length is 7.
      Overrides:
      setDiskName in class FormattedDisk

    • getBitmapDimensions

      public int[] getBitmapDimensions()
      Get suggested dimensions for display of bitmap. Since Pascal disks are a block device, no suggestion is given.
      Specified by:
      getBitmapDimensions in class FormattedDisk

    • getBitmapLength

      public int getBitmapLength()
      Get the length of the bitmap.
      Specified by:
      getBitmapLength in class FormattedDisk

    • getDiskUsage

      public FormattedDisk.DiskUsage getDiskUsage()
      Get the disk usage iterator.
      Specified by:
      getDiskUsage in class FormattedDisk

    • getBitmapLabels

      public String[] getBitmapLabels()
      Get the labels to use in the bitmap.
      Specified by:
      getBitmapLabels in class FormattedDisk

    • getDiskInformation

      public List<FormattedDisk.DiskInformation> getDiskInformation()
      Get Pascal-specific disk information.
      Overrides:
      getDiskInformation in class FormattedDisk

    • getFileColumnHeaders

      public List<FormattedDisk.FileColumnHeader> getFileColumnHeaders(int displayMode)
      Get the standard file column header information. This default implementation is intended only for standard mode.
      Overrides:
      getFileColumnHeaders in class FormattedDisk

    • supportsDeletedFiles

      public boolean supportsDeletedFiles()
      Indicates if this disk format supports "deleted" files.
      Specified by:
      supportsDeletedFiles in class FormattedDisk

    • canReadFileData

      public boolean canReadFileData()
      Indicates if this disk image can read data from a file.
      Specified by:
      canReadFileData in class FormattedDisk

    • canWriteFileData

      public boolean canWriteFileData()
      Indicates if this disk image can write data to a file.
      Specified by:
      canWriteFileData in class FormattedDisk

    • canDeleteFile

      public boolean canDeleteFile()
      Indicates if this disk image can delete a file.
      Specified by:
      canDeleteFile in class FormattedDisk

    • getFileData

      public byte[] getFileData(FileEntry fileEntry)
      Get the data associated with the specified FileEntry.
      Specified by:
      getFileData in class FormattedDisk
      See Also:

    • format

      public void format()
      Format the disk as an Apple Pascal disk.
      Specified by:
      format in class FormattedDisk
      See Also:

    • getLogicalDiskNumber

      public int getLogicalDiskNumber()
      Returns the logical disk number. Returns a 0 to indicate no numbering.
      Specified by:
      getLogicalDiskNumber in class FormattedDisk

    • getSuggestedFilename

      public String getSuggestedFilename(String filename)
      Returns a valid filename for the given filename.

      Summary taken from the filename description in "Apple Pascal: Operating System Reference Manual."

      A legal diskette filename can consist of up to 15 characters. Lower- case letters typed into a filename are translated to upper-case, and spaces and non-printing characters are removed from the filename. All characters are legal in filenames. However, from the keyboard you should not type filenames that include the following characters: dollar sign ($), left square bracket ([), equals sign (=) question mark, (?), RETURN, and the CTRL characters C, F, M, S, U, and @.

      WARNING: The Filer will not be able to access filenames containing the characters dollar sign ($), equals sign (=), question mark (?), or comma (,)

      Specified by:
      getSuggestedFilename in class FormattedDisk

    • getSuggestedFiletype

      public String getSuggestedFiletype(String filename)
      Returns a valid filetype for the given filename. The most simple format will just assume a filetype of binary. This method is available for the interface to make an intelligent first guess as to the filetype.
      Specified by:
      getSuggestedFiletype in class FormattedDisk

    • getFiletypes

      public String[] getFiletypes()
      Returns a list of possible file types. Since the filetype is specific to each operating system, a simple String is used.
      Specified by:
      getFiletypes in class FormattedDisk

    • needsAddress

      public boolean needsAddress(String filetype)
      Indicates if this filetype requires an address component. No Pascal filetypes require or support an address.
      Specified by:
      needsAddress in class FormattedDisk

    • supportsDiskMap

      public boolean supportsDiskMap()
      Indicates if this FormattedDisk supports a disk map.
      Overrides:
      supportsDiskMap in class FormattedDisk

    • setFileData

      public void setFileData(FileEntry fileEntry, byte[] fileData)
      Writes the raw bytes into the file. This bypasses any special formatting of the data (such as prepending the data with a length and/or an address). Typically, the FileEntry.setFileData method should be used.
      Specified by:
      setFileData in class FormattedDisk

    • createDirectory

      public DirectoryEntry createDirectory(String name)
      Create a new DirectoryEntry.
      See Also:

    • getDiskGeometry

      public DiskGeometry getDiskGeometry()
      Gives an indication on how this disk's geometry should be handled.
      Specified by:
      getDiskGeometry in class FormattedDisk

    • toNativeFiletype

      public String toNativeFiletype(String prodosFiletype)
      Provides conversation from a given ProDOS file type since as it is common across many archiving tools.
      Specified by:
      toNativeFiletype in class FormattedDisk

    • toProdosFiletype

      public String toProdosFiletype(String nativeFiletype)
      Provides conversation to a given ProDOS file type since as it is common across many archiving tools.
      Specified by:
      toProdosFiletype in class FormattedDisk