Java Platform 1.2

java.util.zip
Class CheckedInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.FilterInputStream
              |
              +--java.util.zip.CheckedInputStream

public class CheckedInputStream
extends FilterInputStream

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 Also:
Checksum

Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
CheckedInputStream(InputStream in, Checksum cksum)
          Creates an input stream using the specified Checksum.
 
Method Summary
 Checksum getChecksum()
          Returns the Checksum for this input stream.
 int read()
          Reads a byte.
 int read(byte[] buf, int off, int len)
          Reads into an array of bytes.
 long skip(long n)
          Skips specified number of bytes of input.
 
Methods inherited from class java.io.FilterInputStream
available, close, mark, markSupported, read, reset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckedInputStream

public CheckedInputStream(InputStream in,
                          Checksum cksum)
Creates an input stream using the specified Checksum.
Parameters:
in - the input stream
cksum - the Checksum
Method Detail

read

public int read()
         throws IOException
Reads a byte. Will block if no input is available.
Returns:
the byte read, or -1 if the end of the stream is reached.
Throws:
IOException - if an I/O error has occurred
Overrides:
read in class FilterInputStream

read

public int read(byte[] buf,
                int off,
                int len)
         throws IOException
Reads into an array of bytes. Will block until some input is available.
Parameters:
buf - the buffer into which the data is read
off - the start offset of the data
len - the maximum number of bytes read
Returns:
the actual number of bytes read, or -1 if the end of the stream is reached.
Throws:
IOException - if an I/O error has occurred
Overrides:
read in class FilterInputStream

skip

public long skip(long n)
          throws IOException
Skips specified number of bytes of input.
Parameters:
n - the number of bytes to skip
Returns:
the actual number of bytes skipped
Throws:
IOException - if an I/O error has occurred
Overrides:
skip in class FilterInputStream

getChecksum

public Checksum getChecksum()
Returns the Checksum for this input stream.

Java Platform 1.2

Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.