View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one or more
3    *  contributor license agreements.  See the NOTICE file distributed with
4    *  this work for additional information regarding copyright ownership.
5    *  The ASF licenses this file to You under the Apache License, Version 2.0
6    *  (the "License"); you may not use this file except in compliance with
7    *  the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  package org.apache.commons.compress.utils;
18  
19  import java.io.InputStream;
20  import java.util.zip.CRC32;
21  
22  /**
23   * A stream that verifies the CRC of the data read once the stream is exhausted.
24   *
25   * @NotThreadSafe
26   * @since 1.6
27   */
28  public class CRC32VerifyingInputStream extends ChecksumVerifyingInputStream {
29      // TODO Use Commons IO 2.16.0 ChecksumInputStream
30  
31      /**
32       * Constructs a new instance.
33       *
34       * @param in            the stream to wrap
35       * @param size          the of the stream's content
36       * @param expectedCrc32 the expected checksum
37       * @deprecated No longer used.
38       */
39      @Deprecated
40      public CRC32VerifyingInputStream(final InputStream in, final long size, final int expectedCrc32) {
41          this(in, size, expectedCrc32 & 0xFFFFffffL);
42      }
43  
44      /**
45       * Constructs a new instance.
46       *
47       * @param in            the stream to wrap
48       * @param size          the of the stream's content
49       * @param expectedCrc32 the expected checksum
50       * @since 1.7
51       */
52      public CRC32VerifyingInputStream(final InputStream in, final long size, final long expectedCrc32) {
53          super(new CRC32(), in, size, expectedCrc32);
54      }
55  
56  }