Interface FilePacker

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    Bzip2FilePacker, GzipFilePacker, TarFilePacker, ZipFilePacker

    public interface FilePacker
    extends AutoCloseable
    This interface should be implemented by classes that can pack files and directories from BASE file system. The implementing class must also have a public no-argument constructor. The implementing classes are used by the PackedFileExporter plug-in. Each class should be registered in a PluginConfiguration for the PackedFileExporter.
    Version:
    2.4
    Author:
    Martin, Nicklas
    Last modified
    $Date: 2006-11-30 10:50:05 +0100 (Thu, 30 Nov 2006) $
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      End the packing and close.
      String getDescription()
      Get a short description of this file format that is suitable for display in selection list boxes.
      String getFileExtension()
      Gets the extension that files, packed with this tool, should have, for example, zip or tar.gz Don't include the first dot!
      String getMimeType()
      Gets the MIME type to give compressed files from this packer
      void pack​(String entryName, InputStream in, long size, long lastModified)
      Compress the uncompressed input stream to an entry with the given name into the outputstream.
      void setOutputStream​(OutputStream out)
      The output stream that the compressed files should be written to.
    • Method Detail

      • getDescription

        String getDescription()
        Get a short description of this file format that is suitable for display in selection list boxes.
      • getFileExtension

        String getFileExtension()
        Gets the extension that files, packed with this tool, should have, for example, zip or tar.gz Don't include the first dot!
        Returns:
        A String with the file extension excluding the dot
      • getMimeType

        String getMimeType()
        Gets the MIME type to give compressed files from this packer
        Returns:
        The MIME type of the compressed file format
      • setOutputStream

        void setOutputStream​(OutputStream out)
                      throws IOException
        The output stream that the compressed files should be written to.
        Parameters:
        out - The output stream to write to
        Throws:
        IOException - If there is an error setting the output stream
      • pack

        void pack​(String entryName,
                  InputStream in,
                  long size,
                  long lastModified)
           throws IOException
        Compress the uncompressed input stream to an entry with the given name into the outputstream.
        Parameters:
        entryName - The name of the packed resource, including path information
        in - The input stream to read uncompressed data from, or null if the entry represents a directory
        size - The number of bytes of uncompressed data
        lastModified - The time the contents was last modified, or 0 if not known
        Throws:
        IOException - If there are any errors when reading or writing