Class DownloadPackage

  • Direct Known Subclasses:
    DownloadPackage

    public class DownloadPackage
    extends Object
    A simple container object to associate a StorageObject with an output file or output stream to which the object's data will be written.
    Author:
    James Murty
    • Method Detail

      • getDataFile

        public File getDataFile()
        Returns:
        the target output file for data, or null if this package has an output stream as its target.
      • isAppendToFile

        public boolean isAppendToFile()
      • setAppendToFile

        public void setAppendToFile​(boolean appendToFile)
        Data will be appended to the target file instead of overwriting it. This option is relevant only for packages with a target file, not those with a target output stream.
        Parameters:
        appendToFile -
      • getOutputStream

        public OutputStream getOutputStream()
                                     throws Exception
        Creates an output stream to receive the object's data. The output stream is either the output stream provided to this package in its constructor, or an automatically-created FileOutputStream if a File object was provided as the target output object. The output stream will also be wrapped in a GZipInflatingOutputStream if isUnzipping is true and/or a decrypting output stream if this package has an associated non-null EncryptionUtil.
        Returns:
        an output stream that writes data to the output target managed by this class.
        Throws:
        Exception