Package okio

Class GzipSource

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, Source

    public final class GzipSource
    extends java.lang.Object
    implements Source
    A source that uses GZIP to decompress data read from another source.
    • Constructor Summary

      Constructors 
      Constructor Description
      GzipSource​(Source source)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes this source and releases the resources held by this source.
      long read​(Buffer sink, long byteCount)
      Removes at least 1, and up to byteCount bytes from this and appends them to sink.
      Timeout timeout()
      Returns the timeout for this source.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GzipSource

        public GzipSource​(Source source)
    • Method Detail

      • read

        public long read​(Buffer sink,
                         long byteCount)
                  throws java.io.IOException
        Description copied from interface: Source
        Removes at least 1, and up to byteCount bytes from this and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.
        Specified by:
        read in interface Source
        Throws:
        java.io.IOException
      • timeout

        public Timeout timeout()
        Description copied from interface: Source
        Returns the timeout for this source.
        Specified by:
        timeout in interface Source
      • close

        public void close()
                   throws java.io.IOException
        Description copied from interface: Source
        Closes this source and releases the resources held by this source. It is an error to read a closed source. It is safe to close a source more than once.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface Source
        Throws:
        java.io.IOException