Module io.github.tonywasher.joceanus.gordianknot
Package io.github.tonywasher.joceanus.gordianknot.api.zip

Interface GordianZipReadFile

public interface GordianZipReadFile
GordianKnot Zip ReadFile API.

  • Method Details

    • getContents

      GordianZipFileContents getContents()
      Obtain the contents.
      Returns:
      the contents

    • isEncrypted

      boolean isEncrypted()
      Is the zip file encrypted?
      Returns:
      true/false

    • getLock

      GordianZipLock getLock()
      Obtain the lock for the file.
      Returns:
      the lock

    • createInputStream

      InputStream createInputStream(GordianZipFileEntry pFile) throws GordianException
      Obtain an input stream for an entry in the zip file.
      Parameters:
      pFile - the file details for the new zip entry
      Returns:
      the input stream
      Throws:
      GordianException - on error

    • readXMLDocument

      Document readXMLDocument(GordianZipFileEntry pFile) throws GordianException
      Read an entry in the zip file and parse as an XML Document.
      Parameters:
      pFile - the file details for the new zip entry
      Returns:
      the parsed XML Document
      Throws:
      GordianException - on error