Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

CheckedInputStream

extends FilterInputStream

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

Class Overview

The CheckedInputStream class is used to maintain a running Checksum of all data read from a stream.

Summary

[Expand]

Inherited Fields

From class java.io.FilterInputStream

Public Constructors
	CheckedInputStream(InputStream is, Checksum csum) Constructs a new CheckedInputStream on InputStream is.

Public Methods
Checksum	getChecksum() Returns the Checksum calculated on the stream thus far.
int	read(byte[] buf, int off, int nbytes) Reads up to nbytes of data from the underlying stream, storing it in buf, starting at offset off.
int	read() Reads a byte of data from the underlying stream and recomputes the Checksum with the byte data.
long	skip(long nbytes) Skip upto nbytes of data on the underlying stream.

[Expand]

Inherited Methods

From class java.io.FilterInputStream

int	available() Returns a int representing the number of bytes that are available before this FilterInputStream will block.
void	close() Close this FilterInputStream.
synchronized void	mark(int readlimit) Set a Mark position in this FilterInputStream.
boolean	markSupported() Returns a boolean indicating whether or not this FilterInputStream supports mark() and reset().
int	read(byte[] buffer, int offset, int count) Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`.
int	read(byte[] buffer) Reads bytes from this FilterInputStream and stores them in byte array `buffer`.
int	read() Reads a single byte from this FilterInputStream and returns the result as an int.
synchronized void	reset() Reset this FilterInputStream to the last marked location.
long	skip(long count) Skips `count` number of bytes in this InputStream.

From class java.io.InputStream

int	available() Returns a int representing then number of bytes that are available before this InputStream will block.
void	close() Close the InputStream.
void	mark(int readlimit) Set a Mark position in this InputStream.
boolean	markSupported() Returns a boolean indicating whether or not this InputStream supports mark() and reset().
int	read(byte[] b, int offset, int length) Reads at most `length` bytes from the Stream and stores them in byte array `b` starting at `offset`.
int	read(byte[] b) Reads bytes from the Stream and stores them in byte array `b`.
abstract int	read() Reads a single byte from this InputStream and returns the result as an int.
synchronized void	reset() Reset this InputStream to the last marked location.
long	skip(long n) Skips `n` number of bytes in this InputStream.

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

From interface java.io.Closeable

Public Constructors

public CheckedInputStream (InputStream is, Checksum csum)

Constructs a new CheckedInputStream on InputStream is. The Checksum will be calculated using the algorithm implemented by csum.

Parameters

is	InputStream to calculate checksum from
csum	Type of Checksum to calculate

Public Methods

public Checksum getChecksum ()

Returns the Checksum calculated on the stream thus far.

Returns

A java.util.zip.Checksum

public int read (byte[] buf, int off, int nbytes)

Reads up to nbytes of data from the underlying stream, storing it in buf, starting at offset off. The Checksum is updated with the bytes read.

Parameters

buf	the byte array in which to store the read bytes.
off	the offset in `buffer` to store the read bytes.
nbytes	the maximum number of bytes to store in `buffer`.

Returns

Number of bytes read, -1 if end of stream

Throws

IOException

public int read ()

Reads a byte of data from the underlying stream and recomputes the Checksum with the byte data.

Returns

-1 if end of stream, a single byte value otherwise

Throws

IOException

public long skip (long nbytes)

Skip upto nbytes of data on the underlying stream. Any skipped bytes are added to the running Checksum value.

Parameters

nbytes	long Number of bytes to skip

Returns

Number of bytes skipped

Throws

IOException

Feb	MAR	Apr
	10
2008	2009	2010

Interfaces

Classes

Exceptions

CheckedInputStream

Class Overview

Summary

Public Constructors

public CheckedInputStream (InputStream is, Checksum csum)

Parameters

Public Methods

public Checksum getChecksum ()

Returns

public int read (byte[] buf, int off, int nbytes)

Parameters

Returns

Throws

public int read ()

Returns

Throws

public long skip (long nbytes)

Parameters

Returns

Throws