com.tinyline.util
Class GZIPInputStream

java.lang.Object
  java.io.InputStream
      com.tinyline.util.GZIPInputStream

public class GZIPInputStream

extends java.io.InputStream

This class implements a stream filter for reading compressed data in the GZIP format. The "GZIP" format is described in RFC 1952

version 1.8.2

Copyright (c) 2002-2005 TinyLine. All Rights Reserved.

Constructor Summary

GZIPInputStream(java.io.InputStream in)
Creates a new input stream with a default buffer size.

GZIPInputStream(java.io.InputStream inputstream, int size)
Creates a new input stream with the specified buffer size.

Method Summary

int	available() Returns the number of bytes that can be read from this input stream without blocking.
void	close() Closes the input stream.
void	mark(int readlimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark
int	read() Reads a byte of uncompressed data.
int	read(byte[] b) Reads uncompressed data into an array of bytes.
int	read(byte[] buffer, int offset, int length) Reads uncompressed data into an array of bytes.
void	reset() Repositions this stream to the position at the time the mark method was last called on this input stream.
long	skip(long n) Skips specified number of bytes of uncompressed data.

Methods inherited from class java.lang.Object

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

Constructor Detail

GZIPInputStream

public GZIPInputStream(java.io.InputStream inputstream,
                       int size)
                throws java.io.IOException

Creates a new input stream with the specified buffer size.

Parameters:

size - the input buffer size

Throws:

java.io.IOException - if an I/O error has occurred

GZIPInputStream

public GZIPInputStream(java.io.InputStream in)
                throws java.io.IOException

Creates a new input stream with a default buffer size.

Parameters:

in - the input stream

Throws:

java.io.IOException - if an I/O error has occurred

Method Detail

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws java.io.IOException

Reads uncompressed data into an array of bytes. Blocks until enough input is available for decompression.

Parameters:

buffer - the buffer into which the data is read

offset - the start offset of the data

length - the maximum number of bytes read

Returns:

the actual number of bytes read, or -1 if the end of the compressed input stream is reached

Throws:

java.io.IOException - if an I/O error has occurred or the compressed input data is corrupt

read

public int read()
         throws java.io.IOException

Reads a byte of uncompressed data. This method will block until enough input is available for decompression.

Returns:

the byte read, or -1 if end of compressed input is reached

Throws:

java.io.IOException - if an I/O error has occurred

read

public int read(byte[] b)
         throws java.io.IOException

Reads uncompressed data into an array of bytes. This method will block until some input can be decompressed.

Parameters:

b - the buffer into which the data is read

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if an I/O error occurs.

close

public void close()
           throws java.io.IOException

Closes the input stream.

Throws:

java.io.IOException - if an I/O error has occurred

skip

public long skip(long n)
          throws java.io.IOException

Skips specified number of bytes of uncompressed data.

Parameters:

n - the number of bytes to skip.

Returns:

the actual number of bytes skipped.

Throws:

java.io.IOException - if an I/O error has occurred

available

public int available()
              throws java.io.IOException

Returns the number of bytes that can be read from this input stream without blocking.

Returns:

the number of bytes that can be read from the input stream without blocking.

Throws:

java.io.IOException - if an I/O error occurs.

mark

public void mark(int readlimit)

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

Parameters:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

reset

public void reset()
           throws java.io.IOException

Repositions this stream to the position at the time the mark method was last called on this input stream.

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Throws:

java.io.IOException - if the stream has not been marked or if the mark has been invalidated.

markSupported

public boolean markSupported()

Tests if this input stream supports the mark

Returns:

true if this stream type supports the mark and reset method; false otherwise.