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 ch.boye.httpclientandroidlib.client.cache; 28 29 import ch.boye.httpclientandroidlib.annotation.NotThreadSafe; 30 31 /** 32 * Used to limiting the size of an incoming response body of 33 * unknown size that is optimistically being read in anticipation 34 * of caching it. 35 * @since 4.1 36 */ 37 @NotThreadSafe // reached 38 public class InputLimit { 39 40 private final long value; 41 private boolean reached; 42 43 /** 44 * Create a limit for how many bytes of a response body to 45 * read. 46 * @param value maximum length in bytes 47 */ InputLimit(final long value)48 public InputLimit(final long value) { 49 super(); 50 this.value = value; 51 this.reached = false; 52 } 53 54 /** 55 * Returns the current maximum limit that was set on 56 * creation. 57 */ getValue()58 public long getValue() { 59 return this.value; 60 } 61 62 /** 63 * Used to report that the limit has been reached. 64 */ reached()65 public void reached() { 66 this.reached = true; 67 } 68 69 /** 70 * Returns {@code true} if the input limit has been reached. 71 */ isReached()72 public boolean isReached() { 73 return this.reached; 74 } 75 76 } 77