001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one or more
003 *  contributor license agreements.  See the NOTICE file distributed with
004 *  this work for additional information regarding copyright ownership.
005 *  The ASF licenses this file to You under the Apache License, Version 2.0
006 *  (the "License"); you may not use this file except in compliance with
007 *  the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 */
017package org.apache.commons.compress.utils;
018
019import java.io.InputStream;
020import java.util.zip.CRC32;
021
022/**
023 * A stream that verifies the CRC of the data read once the stream is exhausted.
024 *
025 * @NotThreadSafe
026 * @since 1.6
027 */
028public class CRC32VerifyingInputStream extends ChecksumVerifyingInputStream {
029    // TODO Use Commons IO 2.16.0 ChecksumInputStream
030
031    /**
032     * Constructs a new instance.
033     *
034     * @param in            the stream to wrap
035     * @param size          the of the stream's content
036     * @param expectedCrc32 the expected checksum
037     * @deprecated No longer used.
038     */
039    @Deprecated
040    public CRC32VerifyingInputStream(final InputStream in, final long size, final int expectedCrc32) {
041        this(in, size, expectedCrc32 & 0xFFFFffffL);
042    }
043
044    /**
045     * Constructs a new instance.
046     *
047     * @param in            the stream to wrap
048     * @param size          the of the stream's content
049     * @param expectedCrc32 the expected checksum
050     * @since 1.7
051     */
052    public CRC32VerifyingInputStream(final InputStream in, final long size, final long expectedCrc32) {
053        super(new CRC32(), in, size, expectedCrc32);
054    }
055
056}