1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27 package org.apache.http.client.cache;
28
29 /**
30 * Used to limiting the size of an incoming response body of
31 * unknown size that is optimistically being read in anticipation
32 * of caching it.
33 * @since 4.1
34 */
35 public class InputLimit {
36
37 private final long value;
38 private boolean reached;
39
40 /**
41 * Create a limit for how many bytes of a response body to
42 * read.
43 * @param value maximum length in bytes
44 */
45 public InputLimit(final long value) {
46 super();
47 this.value = value;
48 this.reached = false;
49 }
50
51 /**
52 * Returns the current maximum limit that was set on
53 * creation.
54 */
55 public long getValue() {
56 return this.value;
57 }
58
59 /**
60 * Used to report that the limit has been reached.
61 */
62 public void reached() {
63 this.reached = true;
64 }
65
66 /**
67 * Returns {@code true} if the input limit has been reached.
68 */
69 public boolean isReached() {
70 return this.reached;
71 }
72
73 }