Package 

Interface Archive.Entry

  • All Implemented Interfaces:
    org.readium.r2.shared.util.SuspendingCloseable 
    
public interface Archive.Entry
 implements SuspendingCloseable

    Holds an archive entry's metadata.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract ByteArray read(LongRange range) Reads the whole content of this entry.
      abstract String getPath() Absolute path to the entry in the archive.
      abstract Long getLength() Uncompressed data length.
      abstract Long getCompressedLength() Compressed data length.

      • Methods inherited from class org.readium.r2.shared.util.SuspendingCloseable

        close

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • read

         abstract ByteArray read(LongRange range)

        Reads the whole content of this entry. When range is null, the whole content is returned. Out-of-range indexes are clamped to the available length automatically.

      • getPath

         abstract String getPath()

        Absolute path to the entry in the archive. It MUST start with /.