com.numdata.oss.io.CountingOutputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of numdata-commons Show documentation
Miscellaneous basic Java tools.
There is a newer version: 1.22
/*
 * Copyright (c) 2017, Numdata BV, The Netherlands.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Numdata nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NUMDATA BV BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.numdata.oss.io;

import java.io.*;

/**
 * Output stream that counts the number of bytes written to it.
 *
 * @author G. Meinders
 */
public class CountingOutputStream
extends FilterOutputStream
{
	/**
	 * Number of bytes written to the stream.
	 */
	private int _bytesWritten = 0;

	/**
	 * Constructs a new output stream. Any data sent to the stream is
	 * discarded.
	 */
	public CountingOutputStream()
	{
		super( new NullOutputStream() );
	}

	/**
	 * Constructs a new output stream.
	 *
	 * @param outputStream Underlying output stream, or {@code null}.
	 */
	public CountingOutputStream( final OutputStream outputStream )
	{
		super( outputStream );
	}

	/**
	 * Resets the byte counter to {@code 0}.
	 */
	public void reset()
	{
		_bytesWritten = 0;
	}

	/**
	 * Returns the number of bytes written to the stream.
	 *
	 * @return Number of bytes written.
	 */
	public int getBytesWritten()
	{
		return _bytesWritten;
	}

	@Override
	public void write( final int b )
	throws IOException
	{
		_bytesWritten++;
		out.write( b );
	}

	@Override
	public void write( final byte[] b, final int off, final int len )
	throws IOException
	{
		_bytesWritten += len;
		out.write( b, off, len );
	}
}