Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Java™ Platform Standard Ed. 6
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.util.zip
Class CheckedInputStream

    java.lang.Object
      java.io.InputStream
          java.io.FilterInputStream
              java.util.zip.CheckedInputStream

All Implemented Interfaces:
  Closeable

    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`

Field Summary

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.

  Overrides:
    `read` in class `FilterInputStream`
  Returns:
    the byte read, or -1 if the end of the stream is reached.
  Throws:
    `IOException` - if an I/O error has occurred
  See Also:
    `FilterInputStream.in`

### read

    public int read(byte[] buf,
                    int off,
                    int len)
             throws IOException

  Reads into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned.

  Overrides:
    `read` in class `FilterInputStream`
  Parameters:
    `buf` - the buffer into which the data is read
    `off` - the start offset in the destination array `b`
    `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:
    `NullPointerException` - If `buf` is `null`.
    `IndexOutOfBoundsException` - If `off` is negative, `len` is negative, or `len` is greater than `buf.length - off`
    `IOException` - if an I/O error has occurred
  See Also:
    `FilterInputStream.in`

### skip

    public long skip(long n)
              throws IOException

  Skips specified number of bytes of input.

  Overrides:
    `skip` in class `FilterInputStream`
  Parameters:
    `n` - the number of bytes to skip
  Returns:
    the actual number of bytes skipped
  Throws:
    `IOException` - if an I/O error has occurred

### getChecksum

    public Checksum getChecksum()

  Returns the Checksum for this input stream.

  Returns:
    the Checksum value

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Java™ Platform Standard Ed. 6
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.