14fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/* 24fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Licensed to the Apache Software Foundation (ASF) under one or more 34fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * contributor license agreements. See the NOTICE file distributed with 44fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * this work for additional information regarding copyright ownership. 54fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * The ASF licenses this file to You under the Apache License, Version 2.0 64fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * (the "License"); you may not use this file except in compliance with 74fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * the License. You may obtain a copy of the License at 84fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 94fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * http://www.apache.org/licenses/LICENSE-2.0 104fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 114fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Unless required by applicable law or agreed to in writing, software 124fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * distributed under the License is distributed on an "AS IS" BASIS, 134fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 144fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * See the License for the specific language governing permissions and 154fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * limitations under the License. 164fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 174fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypackage org.apache.commons.io.output; 184fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 194fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.IOException; 204fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.OutputStream; 214fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 224fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/** 234fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * A decorating output stream that counts the number of bytes that have passed 244fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * through the stream so far. 254fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 264fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * A typical use case would be during debugging, to ensure that data is being 274fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * written as expected. 284fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 294fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @version $Id: CountingOutputStream.java 471628 2006-11-06 04:06:45Z bayard $ 304fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 314fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypublic class CountingOutputStream extends ProxyOutputStream { 324fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 334fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** The count of bytes that have passed. */ 344fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy private long count; 354fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 364fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 374fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Constructs a new CountingOutputStream. 384fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 394fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param out the OutputStream to write to 404fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 414fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public CountingOutputStream( OutputStream out ) { 424fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy super(out); 434fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 444fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 454fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy //----------------------------------------------------------------------- 464fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 474fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Writes the contents of the specified byte array to this output stream 484fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * keeping count of the number of bytes written. 494fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 504fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param b the bytes to write, not null 514fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 524fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @see java.io.OutputStream#write(byte[]) 534fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 544fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(byte[] b) throws IOException { 554fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy count += b.length; 564fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy super.write(b); 574fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 584fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 594fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 604fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Writes a portion of the specified byte array to this output stream 614fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * keeping count of the number of bytes written. 624fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 634fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param b the bytes to write, not null 644fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param off the start offset in the buffer 654fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param len the maximum number of bytes to write 664fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 674fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @see java.io.OutputStream#write(byte[], int, int) 684fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 694fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(byte[] b, int off, int len) throws IOException { 704fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy count += len; 714fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy super.write(b, off, len); 724fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 734fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 744fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 754fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Writes a single byte to the output stream adding to the count of the 764fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * number of bytes written. 774fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 784fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param b the byte to write 794fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 804fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @see java.io.OutputStream#write(int) 814fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 824fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(int b) throws IOException { 834fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy count++; 844fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy super.write(b); 854fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 864fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 874fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy //----------------------------------------------------------------------- 884fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 894fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * The number of bytes that have passed through this stream. 904fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 914fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * NOTE: From v1.3 this method throws an ArithmeticException if the 924fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * count is greater than can be expressed by an <code>int</code>. 934fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * See {@link #getByteCount()} for a method using a <code>long</code>. 944fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 954fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return the number of bytes accumulated 964fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws ArithmeticException if the byte count is too large 974fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 984fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public synchronized int getCount() { 994fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy long result = getByteCount(); 1004fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy if (result > Integer.MAX_VALUE) { 1014fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy throw new ArithmeticException("The byte count " + result + " is too large to be converted to an int"); 1024fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1034fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return (int) result; 1044fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1054fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 1064fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 1074fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Set the byte count back to 0. 1084fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 1094fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * NOTE: From v1.3 this method throws an ArithmeticException if the 1104fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * count is greater than can be expressed by an <code>int</code>. 1114fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * See {@link #resetByteCount()} for a method using a <code>long</code>. 1124fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 1134fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return the count previous to resetting 1144fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws ArithmeticException if the byte count is too large 1154fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 1164fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public synchronized int resetCount() { 1174fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy long result = resetByteCount(); 1184fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy if (result > Integer.MAX_VALUE) { 1194fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy throw new ArithmeticException("The byte count " + result + " is too large to be converted to an int"); 1204fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1214fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return (int) result; 1224fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1234fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 1244fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 1254fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * The number of bytes that have passed through this stream. 1264fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 1274fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * NOTE: This method is an alternative for <code>getCount()</code>. 1284fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * It was added because that method returns an integer which will 1294fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * result in incorrect count for files over 2GB. 1304fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 1314fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return the number of bytes accumulated 1324fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @since Commons IO 1.3 1334fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 1344fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public synchronized long getByteCount() { 1354fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return this.count; 1364fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1374fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 1384fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 1394fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Set the byte count back to 0. 1404fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 1414fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * NOTE: This method is an alternative for <code>resetCount()</code>. 1424fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * It was added because that method returns an integer which will 1434fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * result in incorrect count for files over 2GB. 1444fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 1454fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return the count previous to resetting 1464fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @since Commons IO 1.3 1474fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 1484fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public synchronized long resetByteCount() { 1494fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy long tmp = this.count; 1504fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy this.count = 0; 1514fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return tmp; 1524fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1534fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 1544fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy} 155