CheckedOutputStream

AI-generated Key Takeaways

• CheckedOutputStream is used to maintain a checksum of data being written to an output stream for data integrity verification.

• It uses a Checksum object to calculate and store the checksum.

• getChecksum() method retrieves the calculated checksum.

• write() methods write data to the stream and update the checksum accordingly.

public class CheckedOutputStream extends FilterOutputStream

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 Also

• Checksum

Inherited Field Summary

From class java.io.FilterOutputStream

protected OutputStream

out

The underlying output stream to be filtered.

Public Constructor Summary

CheckedOutputStream(OutputStream out, Checksum cksum) Creates an output stream with the specified Checksum.

Public Method Summary

Checksum	getChecksum() Returns the Checksum for this output stream.
void	write(byte[] b, int off, int len) Writes an array of bytes.
void	write(int b) Writes a byte.

Inherited Method Summary

From class java.io.FilterOutputStream

void	close() Closes this output stream and releases any system resources associated with the stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out to the stream.
void	write(byte[] b) Writes b.length bytes to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes the specified byte to this output stream.

From class java.io.OutputStream

void	close() Closes this output stream and releases any system resources associated with this stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	write(byte[] b) Writes b.length bytes from the specified byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
abstract void	write(int b) Writes the specified byte to this output stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Public Constructors

public CheckedOutputStream (OutputStream out, Checksum cksum)

Creates an output stream with the specified Checksum.

Parameters

out	the output stream
cksum	the checksum

Public Methods

public Checksum getChecksum ()

Returns the Checksum for this output stream.

Returns

• the Checksum

public void write (byte[] b, int off, int len)

Writes an array of bytes. Will block until the bytes are actually written.

Parameters

b	the data to be written
off	the start offset of the data
len	the number of bytes to be written

Throws

IOException	if an I/O error has occurred

public void write (int b)

Writes a byte. Will block until the byte is actually written.

Parameters

b	the byte to be written

Throws

IOException	if an I/O error has occurred