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
23 /**
24 * A stream that limits reading from a wrapped stream to a given number of bytes.
25 *
26 * @NotThreadSafe
27 * @since 1.6
28 * @deprecated Use {@link org.apache.commons.io.input.BoundedInputStream}.
29 */
30 @Deprecated
31 public class BoundedInputStream extends org.apache.commons.io.input.BoundedInputStream {
32
33 /**
34 * Creates the stream that will at most read the given amount of bytes from the given stream.
35 *
36 * @param in the stream to read from
37 * @param size the maximum amount of bytes to read
38 */
39 public BoundedInputStream(final InputStream in, final long size) {
40 super(in, size);
41 setPropagateClose(false);
42 }
43
44 /**
45 * Gets how many bytes remain to read.
46 *
47 * @return bytes how many bytes remain to read.
48 * @since 1.21
49 */
50 public long getBytesRemaining() {
51 return getMaxCount() - 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 }