View Javadoc

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  
28  package org.apache.http.io;
29  
30  /**
31   * Basic buffer properties.
32   *
33   * @since 4.1
34   */
35  public interface BufferInfo {
36  
37      /**
38       * Return length data stored in the buffer
39       *
40       * @return data length
41       */
42      int length();
43  
44      /**
45       * Returns total capacity of the buffer
46       *
47       * @return total capacity
48       */
49      int capacity();
50  
51      /**
52       * Returns available space in the buffer.
53       *
54       * @return available space.
55       */
56      int available();
57  
58  }