Java™ Platform
Standard Ed. 6

java.util.zip
Class CheckedOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.FilterOutputStream
          extended by java.util.zip.CheckedOutputStream
All Implemented Interfaces:
Closeable, Flushable

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

Field Summary
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary
CheckedOutputStream(OutputStream out, Checksum cksum)
          Creates an output stream with the specified Checksum.
 
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.
 
Methods inherited from class java.io.FilterOutputStream
close, flush, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckedOutputStream

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

Parameters:
out - the output stream
cksum - the checksum
Method Detail

write

public void write(int b)
           throws IOException
Writes a byte. Will block until the byte is actually written.

Overrides:
write in class FilterOutputStream
Parameters:
b - the byte to be written
Throws:
IOException - if an I/O error has occurred

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
Writes an array of bytes. Will block until the bytes are actually written.

Overrides:
write in class FilterOutputStream
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
See Also:
FilterOutputStream.write(int)

getChecksum

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

Returns:
the Checksum

Java™ Platform
Standard Ed. 6

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 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.