com.ansca.corona.storage

Class ZipFileEntryInputStream

java.lang.Object

java.io.InputStream

com.ansca.corona.storage.ZipFileEntryInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZipFileEntryInputStream
extends InputStream

Stream used to read decompressed data from one entry within a zip file.

Constructor Summary

Constructors

Constructor and Description
ZipFileEntryInputStream(File file, String entryName) Creates a new input stream for reading decompressed data from one entry within a zip file.
ZipFileEntryInputStream(String filePath, String entryName) Creates a new input stream for reading decompressed data from one entry within a zip file.
ZipFileEntryInputStream(ZipFile zipFile, String entryName) Creates a new input stream for reading decompressed data from one entry within a zip file.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Gets the number of decompressed bytes of the zip file's entry.
void	close() Closes the input stream to the zip file.
void	mark(int readlimit) Sets a mark position in this input stream.
boolean	markSupported() Determines if this input stream supports the mark() and reset() methods.
int	read() Reads a single byte from this stream.
int	read(byte[] buffer) Reads as many bytes from the source that will fill the given array.
int	read(byte[] buffer, int offset, int length) Reads at most the number of bytes specified by "length" from the stream to the given buffer.
void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips the given number of bytes in the stream.
static ZipFileEntryInputStream	tryOpen(File file, String entryName) Safely opens an input stream to the given zip file entry without exceptions.
static ZipFileEntryInputStream	tryOpen(String filePath, String entryName) Safely opens an input stream to the given zip file entry without exceptions.
static ZipFileEntryInputStream	tryOpen(ZipFile file, String entryName) Safely opens an input stream to the given zip file entry without exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileEntryInputStream

public ZipFileEntryInputStream(String filePath,
                       String entryName)
                        throws NullPointerException,
                               IllegalArgumentException,
                               IllegalStateException,
                               IOException,
                               FileNotFoundException,
                               ZipException

Creates a new input stream for reading decompressed data from one entry within a zip file.

Parameters:

filePath - The path and file name of the zip file to be accessed. Cannot be null or empty.

entryName - The unique name of the entry within the zip file. Cannot be null or empty.

Throws:

NullPointerException

IllegalArgumentException

IllegalStateException

IOException

FileNotFoundException

ZipException

ZipFileEntryInputStream

public ZipFileEntryInputStream(File file,
                       String entryName)
                        throws NullPointerException,
                               IllegalArgumentException,
                               IllegalStateException,
                               IOException,
                               FileNotFoundException,
                               ZipException

Creates a new input stream for reading decompressed data from one entry within a zip file.

Parameters:

file - The zip file to be accessed. Cannot be null.

entryName - The unique name of the entry within the zip file. Cannot be null or empty.

Throws:

NullPointerException

IllegalArgumentException

IllegalStateException

IOException

FileNotFoundException

ZipException

ZipFileEntryInputStream

public ZipFileEntryInputStream(ZipFile zipFile,
                       String entryName)
                        throws NullPointerException,
                               IllegalArgumentException,
                               IllegalStateException,
                               IOException,
                               FileNotFoundException,
                               ZipException

Creates a new input stream for reading decompressed data from one entry within a zip file.

Parameters:

file - The zip file to be accessed. Cannot be null.

entryName - The unique name of the entry within the zip file. Cannot be null or empty.

Throws:

NullPointerException

IllegalArgumentException

IllegalStateException

IOException

FileNotFoundException

ZipException

Method Detail

close

public void close()
           throws IOException

Closes the input stream to the zip file.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Gets the number of decompressed bytes of the zip file's entry.

Overrides:

available in class InputStream

Returns:

Returns the number of bytes the entry claims in decompressed form.

Throws:

IOException

mark

public void mark(int readlimit)

Sets a mark position in this input stream.

Overrides:

mark in class InputStream

Parameters:

readlimit - The number of bytes that can be read from this stream before the mark is invalidated.

markSupported

public boolean markSupported()

Determines if this input stream supports the mark() and reset() methods.

Overrides:

markSupported in class InputStream

Returns:

Returns true if mark() and reset() are support. Returns false if not.

reset

public void reset()
           throws IOException

Resets this stream to the last marked location.

Overrides:

reset in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Reads a single byte from this stream.

Blocks until one byte has been read, the end of the source stream has been reached, or when an exception has been thrown.

Specified by:

read in class InputStream

Returns:

Returns the read byte as an integer ranging between 0 and 255.

Returns -1 if the end of the stream has been reached.

Throws:

IOException

read

public int read(byte[] buffer)
         throws IOException,
                IndexOutOfBoundsException

Reads as many bytes from the source that will fill the given array.

Overrides:

read in class InputStream

Parameters:

buffer - The byte array which will stored the read bytes.

Returns:

Returns the number of bytes read or -1 if the end of the stream has been reached.

Throws:

IOException

IndexOutOfBoundsException

read

public int read(byte[] buffer,
       int offset,
       int length)
         throws IOException,
                IndexOutOfBoundsException

Reads at most the number of bytes specified by "length" from the stream to the given buffer.

Overrides:

read in class InputStream

Parameters:

buffer - The byte array which will stored the read bytes.

offset - Zero based index to the position in the "buffer" array to start storing read bytes.

length - The maximum number of bytes to read.

Returns:

Returns the number of bytes read or -1 if the end of the stream has been reached.

Throws:

IOException

IndexOutOfBoundsException

skip

public long skip(long byteCount)
          throws IOException

Skips the given number of bytes in the stream.

Overrides:

skip in class InputStream

Parameters:

byteCount - The number of bytes to skip. Does nothing if less than or equal to zero.

Returns:

Returns the number of bytes skipped.

Throws:

IOException

tryOpen

public static ZipFileEntryInputStream tryOpen(String filePath,
                              String entryName)

Safely opens an input stream to the given zip file entry without exceptions.

Parameters:

filePath - The path and file name of the zip file to be accessed.

entryName - The unique name of the entry within the zip file.

Returns:

Returns an input stream to zip file entry.

Returns null if failed to find the given zip file or its zip entry.

tryOpen

public static ZipFileEntryInputStream tryOpen(File file,
                              String entryName)

Safely opens an input stream to the given zip file entry without exceptions.

Parameters:

file - The zip file to be accessed.

entryName - The unique name of the entry within the zip file.

Returns:

Returns an input stream to zip file entry.

Returns null if failed to find the given zip file or its zip entry.

tryOpen

public static ZipFileEntryInputStream tryOpen(ZipFile file,
                              String entryName)

Safely opens an input stream to the given zip file entry without exceptions.

Parameters:

file - The zip file to be accessed.

entryName - The unique name of the entry within the zip file.

Returns:

Returns an input stream to zip file entry.

Returns null if failed to find the given zip file or its zip entry.