libjava/java/util/zip/CheckedOutputStream.java

   1 /* CheckedOutputStream.java - Compute checksum of data being written.
   2    Copyright (C) 1999, 2000 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.util.zip;
  39
  40 import java.io.FilterOutputStream;
  41 import java.io.OutputStream;
  42 import java.io.IOException;
  43
  44 /* Written using on-line Java Platform 1.2 API Specification
  45  * and JCL book.
  46  * Believed complete and correct.
  47  */
  48
  49 /**
  50  * OutputStream that computes a checksum of data being written using a
  51  * supplied Checksum object.
  52  *
  53  * @see Checksum
  54  *
  55  * @author Tom Tromey
  56  * @date May 17, 1999
  57  */
  58 public class CheckedOutputStream extends FilterOutputStream
  59 {
  60   /**
  61    * Creates a new CheckInputStream on top of the supplied OutputStream
  62    * using the supplied Checksum.
  63    */
  64   public CheckedOutputStream (OutputStream out, Checksum cksum)
  65   {
  66     super (out);
  67     this.sum = cksum;
  68   }
  69
  70   /**
  71    * Returns the Checksum object used. To get the data checksum computed so
  72    * far call <code>getChecksum.getValue()</code>.
  73    */
  74   public Checksum getChecksum ()
  75   {
  76     return sum;
  77   }
  78
  79   /**
  80    * Writes one byte to the OutputStream and updates the Checksum.
  81    */
  82   public void write (int bval) throws IOException
  83   {
  84     out.write(bval);
  85     sum.update(bval);
  86   }
  87
  88   /**
  89    * Writes the byte array to the OutputStream and updates the Checksum.
  90    */
  91   public void write (byte[] buf, int off, int len) throws IOException
  92   {
  93     out.write(buf, off, len);
  94     sum.update(buf, off, len);
  95   }
  96
  97   /** The checksum object. */
  98   private Checksum sum;
  99 }