001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     * http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.commons.compress.compressors;
020    
021    import java.io.InputStream;
022    
023    public abstract class CompressorInputStream extends InputStream {
024        private long bytesRead = 0;
025        
026        /**
027         * Increments the counter of already read bytes.
028         * Doesn't increment if the EOF has been hit (read == -1)
029         * 
030         * @param read the number of bytes read
031         *
032         * @since Apache Commons Compress 1.1
033         */
034        protected void count(int read) {
035            count((long) read);
036        }
037        
038        /**
039         * Increments the counter of already read bytes.
040         * Doesn't increment if the EOF has been hit (read == -1)
041         * 
042         * @param read the number of bytes read
043         */
044        protected void count(long read) {
045            if(read != -1) {
046                bytesRead = bytesRead + read;
047            }
048        }
049    
050        /**
051         * Returns the current number of bytes read from this stream.
052         * @return the number of read bytes
053         * @deprecated this method may yield wrong results for large
054         * archives, use #getBytesRead instead
055         */
056        @Deprecated
057        public int getCount() {
058            return (int) bytesRead;
059        }
060    
061        /**
062         * Returns the current number of bytes read from this stream.
063         * @return the number of read bytes
064         *
065         * @since Apache Commons Compress 1.1
066         */
067        public long getBytesRead() {
068            return bytesRead;
069        }
070    }