com.hfg.util.io.FlowMeterInputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.util.io;

import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;


//------------------------------------------------------------------------------
/**
 An InputStream variant for measuring the number of bytes that pass through.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class FlowMeterInputStream extends FilterInputStream
{
   private long mNumBytes = 0;

   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //--------------------------------------------------------------------------

   /**
    * An InputStream that measures the number of bytes that pass through.
    */
   public FlowMeterInputStream(InputStream in)
   {
      super(in);
   }


   //##########################################################################
   // PUBLIC METHODS
   //##########################################################################

   //--------------------------------------------------------------------------
   @Override
   public int read()
         throws IOException
   {
      int theByte = super.read();
      if (theByte > 0)
      {
         mNumBytes++;
      }

      return theByte;
   }

   //--------------------------------------------------------------------------
   @Override
   public int read(byte[] inBytes, int inOffset, int inLength)
         throws IOException
   {
      int numBytesRead = super.read(inBytes, inOffset, inLength);
      if (numBytesRead > 0)
      {
         mNumBytes += numBytesRead;
      }

      return numBytesRead;
   }

   //--------------------------------------------------------------------------
   public void reset()
   {
      mNumBytes = 0;
   }

   //--------------------------------------------------------------------------
   public long getNumBytes()
   {
      return mNumBytes;
   }

   //--------------------------------------------------------------------------
   @Override
   public long skip(long inBytesToSkip)
         throws IOException
   {
      long totalBytesSkipped = 0;
      while (totalBytesSkipped < inBytesToSkip)
      {
         long bytesSkipped = super.skip(inBytesToSkip - totalBytesSkipped);
         mNumBytes += bytesSkipped;
         totalBytesSkipped += bytesSkipped;

         if (0 == bytesSkipped)
         {
            break;
         }
      }

      return totalBytesSkipped;
   }

   //--------------------------------------------------------------------------
   public long skipTo(long inBytesOffset)
         throws IOException
   {
      return skip(inBytesOffset - getNumBytes());
   }
}