J2SE1.3  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

java.util.zip Documentation Differences

This file contains all the changes in documentation in the package java.util.zip as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.
Class Adler32

A class that can be used to compute the Adler-32 checksum of a data stream. An Adler-32 checksum is almost as reliable as a CRC-32 but can be computed much faster. @see Checksum @version 1.19 0722 02/2402/9800 @author David Connelly
Class Adler32, void update(int)

Updates checksum with specified byte. @param b an array of bytes
Class CRC32

A class that can be used to compute the CRC-32 of a data stream. @see Checksum @version 1.21 0424 02/2202/9900 @author David Connelly
Class CRC32, void update(byte[])

Updates checksum with specified array of bytes. @param the array of bytes to update the checksum with
Class CheckedInputStream

An input stream that also maintains a checksum of the data being read. The checksum can then be used to verify the integrity of the input data. @see Checksum @version 1.13 0916 02/2102/9800 @author David Connelly
Class CheckedInputStream, Checksum getChecksum()

Returns the Checksum for this input stream. @return the Checksum value
Class CheckedOutputStream

An output stream that also maintains a checksum of the data being written. The checksum can then be used to verify the integrity of the output data. @see Checksum @version 1.12 0915 02/2102/9800 @author David Connelly
Class CheckedOutputStream, Checksum getChecksum()

Returns the Checksum for this output stream. @return the Checksum
Class CheckedOutputStream, void write(byte[], int, int)

Writes an array of bytes. Will block until the bytes are actually written. @param bufb the data to be written @param off the start offset of the data @param len the number of bytes to be written @exception IOException if an I/O error has occurred
Class Checksum

An interface representing a data checksum. @version 1.10 0913 02/2102/9800 @author David Connelly
Class Checksum, long getValue()

Returns the current checksum value. @return the current checksum value
Class Checksum, void update(byte[], int, int)

Updates the current checksum with the specified array of bytes. @param b the byte array to update the checksum with @param off the start offset of the data @param len the number of bytes to use for the update
Class Checksum, void update(int)

Updates the current checksum with the specified byte. @param b the byte to update the checksum with
Class DataFormatException

Signals that a data format error has occurred. @version 1.8 0910 02/2102/9800 @author David Connelly
Class Deflater

This class provides support for general purpose compression using the popular ZLIB compression library. The ZLIB compression library was initially developed as part of the PNG graphics standard and is not protected by patents. It is fully described in the specifications at the java.util.zip package description. @see Inflater @version 1.31 1034 02/2902/9800 @author David Connelly
Class Deflater, boolean finished()

Returns true if the end of the compressed data output stream has been reached. @return true if the end of the compressed data output stream has been reached
Class Deflater, int getAdler()

Returns the ADLER-32 value of the uncompressed data. @return the ADLER-32 value of the uncompressed data
Class Deflater, int getTotalIn()

Returns the total number of bytes input so far. @return the total number of bytes input so far
Class Deflater, int getTotalOut()

Returns the total number of bytes output so far. @return the total number of bytes output so far
Class Deflater, boolean needsInput()

Returns true if the input data buffer is empty and setInput() should be called in order to provide more input. @return true if the input data buffer is empty and setInput() should be called in order to provide more input
Class DeflaterOutputStream

This class implements an output stream filter for compressing data in the "deflate" compression format. It is also used as the basis for other types of compression filters such as GZIPOutputStream. @see Deflater @version 1.23 0927 02/2102/9800 @author David Connelly
Class DeflaterOutputStream, constructor DeflaterOutputStream(OutputStream)

Creates a new output stream with a defaul compressor and buffer size. @param out the output stream
Class DeflaterOutputStream, constructor DeflaterOutputStream(OutputStream, Deflater, int)

Creates a new output stream with the specified compressor and buffer size. @param out the output stream @param def the compressor ("deflater") @param lensize the output buffer size @exception IllegalArgumentException if size is < 0
Class DeflaterOutputStream, void deflate()

Writes next block of compressed data to the output stream. @throws IOException if an I/O error has occurred
Class DeflaterOutputStream, void write(byte[], int, int)

Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written. @param bufb the data to be written @param off the start offset of the data @param len the length of the data @exception IOException if an I/O error has occurred
Class GZIPInputStream

This class implements a stream filter for reading compressed data in the GZIP format. @see InflaterInputStream @version 1.20 0922 02/2102/9800 @author David Connelly
Class GZIPOutputStream

This class implements a stream filter for writing compressed data in the GZIP file format. @version 1.15 0917 02/2102/9800 @author David Connelly
Class Inflater

This class provides support for general purpose decompression using popular ZLIB compression library. The ZLIB compression library was initially developed as part of the PNG graphics standard and is not protected by patents. It is fully described in the specifications at the java.util.zip package description. @see Deflater @version 1.31 1035 02/2902/9800 @author David Connelly
Class Inflater, boolean finished()

Return true if the end of the compressed data stream has been reached. @return true if the end of the compressed data stream has been reached
Class Inflater, int getAdler()

Returns the ADLER-32 value of the uncompressed data. @return the ADLER-32 value of the uncompressed data
Class Inflater, int getRemaining()

Returns the total number of bytes remaining in the input buffer. This can be used to find out what bytes still remain in the input buffer after decompression has finished. @return the total number of bytes remaining in the input buffer
Class Inflater, int getTotalIn()

Returns the total number of bytes input so far. @return the total number of bytes input so far
Class Inflater, int getTotalOut()

Returns the total number of bytes output so far. @return the total number of bytes output so far
Class Inflater, boolean needsDictionary()

Returns true if a preset dictionary is needed for decompression. @return true if a preset dictionary is needed for decompression @see InflatesetDictionaryInflater#setDictionary
Class Inflater, boolean needsInput()

Returns true if no data remains in the input buffer. This can be used to determine if #setInput should be called in order to provide more input. @return true if no data remains in the input buffer
Class InflaterInputStream

This class implements a stream filter for uncompressing data in the "deflate" compression format. It is also used as the basis for other decompression filters such as GZIPInputStream. @see Inflater @version 1.23 0728 02/2802/9800 @author David Connelly
Class InflaterInputStream, constructor InflaterInputStream(InputStream)

Creates a new input stream with a default decompressor and buffer size. @param in the input stream
Class ZipEntry

This class is used to represent a ZIP file entry. @version 1.26 0631 02/2902/9800 @author David Connelly
Class ZipEntry, constructor ZipEntry(ZipEntry)

Creates a new zip entry with fields taken from the specified zip entry. @param e a zip Entry object
Class ZipEntry, String getComment()

Returns the comment string for the entry or null if none. @return the comment string for the entry or null if none @see #setComment(String)
Class ZipEntry, long getCompressedSize()

Returns the size of the compressed entry data or -1 if not known. In the case of a stored entry the compressed size will be the same as the uncompressed size of the entry. @return the size of the compressed entry data or -1 if not known @see #setCompressedSize(long)
Class ZipEntry, long getCrc()

Returns the CRC-32 checksum of the uncompressed entry data or -1 if not known. @return the CRC-32 checksum of the uncompressed entry data or -1 if not known @see #getCrc()
Class ZipEntry, byte[] getExtra()

Returns the extra field data for the entry or null if none. @return the extra field data for the entry or null if none @see #setExtra(byte[])
Class ZipEntry, int getMethod()

Returns the compression method of the entry or -1 if not specified. @return the compression method of the entry or -1 if not specified @see #setMethod(int)
Class ZipEntry, String getName()

Returns the name of the entry. @return the name of the entry
Class ZipEntry, long getSize()

Returns the uncompressed size of the entry data or -1 if not known. @return the uncompressed size of the entry data or -1 if not known @see #setSize(long)
Class ZipEntry, long getTime()

Returns the modification time of the entry or -1 if not specified. @return the modification time of the entry or -1 if not specified @see #setTime(long)
Class ZipEntry, boolean isDirectory()

Returns true if this is a directory entry. A directory entry is defined to be one whose name ends with a '/'. @return true if this is a directory entry
Class ZipEntry, void setComment(String)

Sets the optional comment string for the entry. @param comment the comment string @exception IllegalArgumentException if the length of the specified comment string is greater than 0xFFFF bytes @see #getComment()
Class ZipEntry, void setCompressedSize(long)

Sets the size of the compressed entry data. @param csize the compressed size to set to @see #getCompressedSize()
Class ZipEntry, void setCrc(long)

Sets the CRC-32 checksum of the uncompressed entry data. @param crc the CRC-32 value @exception IllegalArgumentException if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF @see #setCrc(long)
Class ZipEntry, void setExtra(byte[])

Sets the optional extra field data for the entry. @param extra the extra field data bytes @exception IllegalArgumentException if the length of the specified extra field data is greater than 0xFFFFF bytes @see #getExtra()
Class ZipEntry, void setMethod(int)

Sets the compression method for the entry. @param method the compression method either STORED or DEFLATED @exception IllegalArgumentException if the specified compression method is invalid @see #getMethod()
Class ZipEntry, void setSize(long)

Sets the uncompressed size of the entry data. @param size the uncompressed size in bytes @exception IllegalArgumentException if the specified size is less than 0 or greater than 0xFFFFFFFF bytes @see #getSize()
Class ZipEntry, void setTime(long)

Sets the modification time of the entry. @param time the entry modification time in number of milliseconds since the epoch @see #getTime()
Class ZipFile

This class is used to read entries from a zip file. @version 1.39 0448 02/2202/9900 @author David Connelly
Class ZipFile, void close()

Closes the ZIP file. @throws IOException if an I/O error has occured
Class ZipFile, Enumeration entries()

Returns an enumeration of the ZIP file entries. @return an enumeration of the ZIP file entries @exception IllegalStateException if the zip file has been closed
Class ZipFile, void finalize()

CalledEnsures by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalizeclose method to dispose of system resources or to perform other cleanup. The general contract of finalize isthis that itZIP file is invoked if andcalled when the JavaTM virtual machine has determined that there isare no longer any means by which this object can be accessed by any thread that has not yet died except as a result of an action taken by the finalization of some other object or class which ismore readyreferences to be finalizedit. The finalize

method may take any action including makingSince the time when GC would invoke this object available again to other threads; the usual purpose of finalize howevermethod is to perform cleanup actionsundetermined before the objectit is irrevocably discarded. For example the finalize method for anstrongly objectrecommanded that represents an input/output connection might perform explicit I/O transactions to breakapplications the connection beforeinvoke the object is permanently discarded. The finalizeclose method of class Object performs no special action; it simply returns normally.as Subclasses ofsoon they Objecthave may overridefinished accessing this definition. The Java programming language does not guarantee which thread will invoke the finalize method for any given objectZipFile. ItThis is guaranteed however that the thread that invokes finalize will notprevent be holding any user-visible synchronization locks when finalizeup issystem invoked.resources Iffor an uncaught exception is thrown by the finalize method the exceptionundetermined is ignored and finalizationlength of that object terminatestime. After the finalize method has been@exception invoked forIOException if an object no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died including possible actions by other objects or classes which are ready to be finalized at which point the object mayI/O be discardederror occurs. The finalize@see method is never invoked more than once by a Java virtual machine for any given objectjava. Any exception thrown by the finalize method causes the finalization of this object to be halted but is otherwise ignoredutil.zip.ZipFile#close()

Class ZipFile, InputStream getInputStream(ZipEntry)

Returns an input stream for reading the contents of the specified zip file entry. @param entry the zip file entry @return the input stream for reading the contents of the specified zip file entry. @exception ZipException if a ZIP format error has occurred @exception IOException if an I/O error has occurred @exception IllegalStateException if the zip file has been closed
Class ZipFile, String getName()

Returns the path name of the ZIP file. @return the path name of the ZIP file
Class ZipFile, int size()

Returns the number of entries in the ZIP file. @return the number of entries in the ZIP file @exception IllegalStateException if the zip file has been closed
Class ZipInputStream

This class implements an input stream filter for reading files in the ZIP file format. Includes support for both compressed and uncompressed entries. @author David Connelly @version 1.23 0428 02/2202/9900
Class ZipInputStream, ZipEntry createZipEntry(String)

Creates a new ZipEntry object for the specified entry name. @param name the ZIP file entry name @return the ZipEntry just created
Class ZipInputStream, ZipEntry getNextEntry()

Reads the next ZIP file entry and positions stream at the beginning of the entry data. @return the ZipEntry just read @exception ZipException if a ZIP file error has occurred @exception IOException if an I/O error has occurred
Class ZipOutputStream

This class implements an output stream filter for writing files in the ZIP file format. Includes support for both compressed and uncompressed entries. @author David Connelly @version 1.18 0721 02/0702/9800