net.sf.jazzlib.CheckedOutputStream Maven / Gradle / Ivy

/* CheckedOutputStream.java - Compute checksum of data being written.
   Copyright (C) 1999, 2000 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package net.sf.jazzlib;

import java.io.FilterOutputStream;
import java.io.IOException;
import java.io.OutputStream;

/* Written using on-line Java Platform 1.2 API Specification
 * and JCL book.
 * Believed complete and correct.
 */

/**
 * OutputStream that computes a checksum of data being written using a supplied
 * Checksum object.
 *
 * @see Checksum
 *
 * @author Tom Tromey
 * @date May 17, 1999
 */
public class CheckedOutputStream extends FilterOutputStream {
	/**
	 * Creates a new CheckInputStream on top of the supplied OutputStream using
	 * the supplied Checksum.
	 */
	public CheckedOutputStream(final OutputStream out, final Checksum cksum) {
		super(out);
		this.sum = cksum;
	}

	/**
	 * Returns the Checksum object used. To get the data checksum computed so
	 * far call getChecksum.getValue().
	 */
	public Checksum getChecksum() {
		return sum;
	}

	/**
	 * Writes one byte to the OutputStream and updates the Checksum.
	 */
	@Override
	public void write(final int bval) throws IOException {
		out.write(bval);
		sum.update(bval);
	}

	/**
	 * Writes the byte array to the OutputStream and updates the Checksum.
	 */
	@Override
	public void write(final byte[] buf, final int off, final int len)
			throws IOException {
		out.write(buf, off, len);
		sum.update(buf, off, len);
	}

	/** The checksum object. */
	private final Checksum sum;
}