/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.commons.compress.compressors;

import java.io.InputStream;

public abstract class CompressorInputStream extends InputStream {
    private long bytesRead = 0;

    
Increments the counter of already read bytes.
Doesn't increment if the EOF has been hit (read == -1)
Params:
read – the number of bytes read
Since:
1.1/**
     * Increments the counter of already read bytes.
     * Doesn't increment if the EOF has been hit (read == -1)
     *
     * @param read the number of bytes read
     *
     * @since 1.1
     */
    protected void count(final int read) {
        count((long) read);
    }

    
Increments the counter of already read bytes.
Doesn't increment if the EOF has been hit (read == -1)
Params:
read – the number of bytes read/**
     * Increments the counter of already read bytes.
     * Doesn't increment if the EOF has been hit (read == -1)
     *
     * @param read the number of bytes read
     */
    protected void count(final long read) {
        if (read != -1) {
            bytesRead = bytesRead + read;
        }
    }

    
Decrements the counter of already read bytes.
Params:
pushedBack – the number of bytes pushed back.
Since:
1.7/**
     * Decrements the counter of already read bytes.
     *
     * @param pushedBack the number of bytes pushed back.
     * @since 1.7
     */
    protected void pushedBackBytes(final long pushedBack) {
        bytesRead -= pushedBack;
    }

    
Returns the current number of bytes read from this stream.
Returns:
the number of read bytes
Deprecated:
this method may yield wrong results for large
archives, use #getBytesRead instead/**
     * Returns the current number of bytes read from this stream.
     * @return the number of read bytes
     * @deprecated this method may yield wrong results for large
     * archives, use #getBytesRead instead
     */
    @Deprecated
    public int getCount() {
        return (int) bytesRead;
    }

    
Returns the current number of bytes read from this stream.
Returns:
the number of read bytes
Since:
1.1/**
     * Returns the current number of bytes read from this stream.
     * @return the number of read bytes
     *
     * @since 1.1
     */
    public long getBytesRead() {
        return bytesRead;
    }

    
Returns the amount of raw or compressed bytes read by the stream.
This implementation invokes getBytesRead.
Provides half of InputStreamStatistics without forcing subclasses to implement the other half.
Returns:
the amount of decompressed bytes returned by the stream
Since:
1.17/**
     * Returns the amount of raw or compressed bytes read by the stream.
     *
     * <p>This implementation invokes {@link #getBytesRead}.</p>
     *
     * <p>Provides half of {@link
     * org.apache.commons.compress.utils.InputStreamStatistics}
     * without forcing subclasses to implement the other half.</p>
     *
     * @return the amount of decompressed bytes returned by the stream
     * @since 1.17
     */
    public long getUncompressedCount() {
        return getBytesRead();
    }
}