View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   https://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.commons.compress.utils;
20  
21  import java.io.InputStream;
22  import java.util.Objects;
23  import java.util.zip.CheckedInputStream;
24  import java.util.zip.Checksum;
25  
26  /**
27   * Calculates the checksum of the data read.
28   *
29   * @NotThreadSafe
30   * @since 1.14
31   * @deprecated Use {@link CheckedInputStream}.
32   */
33  @Deprecated
34  public class ChecksumCalculatingInputStream extends CheckedInputStream {
35  
36      /**
37       * Constructs a new instance.
38       *
39       * @param checksum    The checksum to update
40       * @param inputStream The input stream to read.
41       * @deprecated Use {@link CheckedInputStream#CheckedInputStream(InputStream, Checksum)}.
42       */
43      @Deprecated
44      @SuppressWarnings("resource")
45      public ChecksumCalculatingInputStream(final Checksum checksum, final InputStream inputStream) {
46          super(Objects.requireNonNull(inputStream, "inputStream"), Objects.requireNonNull(checksum, "checksum"));
47      }
48  
49      /**
50       * Returns the calculated checksum.
51       *
52       * @return the calculated checksum.
53       * @deprecated Use {@link CheckedInputStream#getChecksum()} and {@link Checksum#getValue()}.
54       */
55      @Deprecated
56      public long getValue() {
57          return getChecksum().getValue();
58      }
59  
60  }