Class CheckedOutputStream

java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
java.util.zip.CheckedOutputStream
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable
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.
Since:
1.1
See Also:

  • Field Summary

    Fields declared in class FilterOutputStream

    out
    Modifier and Type
    Field
    Description
    protected OutputStream
    out
    The underlying output stream to be filtered.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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 declared in class FilterOutputStream

    close, flush, write
    Modifier and Type
    Method
    Description
    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.

    Methods declared in class OutputStream

    nullOutputStream
    Modifier and Type
    Method
    Description
    static OutputStream
    nullOutputStream()
    Returns a new OutputStream which discards all bytes.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers 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 answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    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).
    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(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.

  • Constructor Details

    • CheckedOutputStream

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

  • Method Details

    • 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:

    • getChecksum

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