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.Objects;
21  import java.util.zip.CheckedInputStream;
22  import java.util.zip.Checksum;
23  
24  /**
25   * Calculates the checksum of the data read.
26   *
27   * @NotThreadSafe
28   * @since 1.14
29   * @deprecated Use {@link CheckedInputStream}.
30   */
31  @Deprecated
32  public class ChecksumCalculatingInputStream extends CheckedInputStream {
33  
34      /**
35       * Constructs a new instance.
36       *
37       * @param checksum    The checksum to update
38       * @param inputStream The input stream to read.
39       * @deprecated Use {@link CheckedInputStream#CheckedInputStream(InputStream, Checksum)}.
40       */
41      @Deprecated
42      @SuppressWarnings("resource")
43      public ChecksumCalculatingInputStream(final Checksum checksum, final InputStream inputStream) {
44          super(Objects.requireNonNull(inputStream, "inputStream"), Objects.requireNonNull(checksum, "checksum"));
45      }
46  
47      /**
48       * Returns the calculated checksum.
49       *
50       * @return the calculated checksum.
51       * @deprecated Use {@link CheckedInputStream#getChecksum()} and {@link Checksum#getValue()}.
52       */
53      @Deprecated
54      public long getValue() {
55          return getChecksum().getValue();
56      }
57  
58  }