org.spearce.jgit/src/org/spearce/jgit/util/CountingOutputStream.java

   1 /*
   2  * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.util;
  39
  40 import java.io.FilterOutputStream;
  41 import java.io.IOException;
  42 import java.io.OutputStream;
  43
  44 /**
  45  * Counting output stream decoration. Counts bytes written to stream.
  46  */
  47 public class CountingOutputStream extends FilterOutputStream {
  48         private long count;
  49
  50         /**
  51          * Create counting stream being decorated to provided real output stream.
  52          *
  53          * @param out
  54          *            output stream where data should be written
  55          */
  56         public CountingOutputStream(OutputStream out) {
  57                 super(out);
  58         }
  59
  60         @Override
  61         public void write(int b) throws IOException {
  62                 out.write(b);
  63                 count++;
  64         }
  65
  66         @Override
  67         public void write(byte[] b, int off, int len) throws IOException {
  68                 out.write(b, off, len);
  69                 count += len;
  70         }
  71
  72         /**
  73          * Return number of already written bytes.
  74          *
  75          * @return number of written bytes since last reset (object is reset upon
  76          *         creation)
  77          */
  78         public long getCount() {
  79                 return count;
  80         }
  81
  82         /**
  83          * Reset counter to zero value.
  84          */
  85         public void reset() {
  86                 count = 0;
  87         }
  88 }