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  
21  /**
22   * A stream that limits reading from a wrapped stream to a given number of bytes.
23   *
24   * @NotThreadSafe
25   * @since 1.6
26   * @deprecated Use {@link org.apache.commons.io.input.BoundedInputStream}.
27   */
28  @Deprecated
29  public class BoundedInputStream extends org.apache.commons.io.input.BoundedInputStream {
30  
31      /**
32       * Creates the stream that will at most read the given amount of bytes from the given stream.
33       *
34       * @param in   the stream to read from
35       * @param size the maximum amount of bytes to read
36       */
37      public BoundedInputStream(final InputStream in, final long size) {
38          super(in, size);
39          setPropagateClose(false);
40      }
41  
42      /**
43       * Gets how many bytes remain to read.
44       *
45       * TODO Use Apache Commons IO 2.16.0 org.apache.commons.io.input.BoundedInputStream.getRemaining() when released.
46       *
47       * @return bytes how many bytes remain to read.
48       * @since 1.21
49       */
50      public long getBytesRemaining() {
51          return getMaxLength() - getCount();
52      }
53  
54  //    @Override
55  //    protected void onMaxLength(long maxLength, long count) throws IOException {
56  //        if (count > maxLength) {
57  //            throw new IOException("Can't read past EOF.");
58  //        }
59  //    }
60  }