View Javadoc

1   /*
2    * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/oac.hc3x/trunk/src/java/org/apache/commons/httpclient/ResponseConsumedWatcher.java $
3    * $Revision: 1425331 $
4    * $Date: 2012-12-22 19:29:41 +0100 (Sat, 22 Dec 2012) $
5    *
6    * ====================================================================
7    *
8    *  Licensed to the Apache Software Foundation (ASF) under one or more
9    *  contributor license agreements.  See the NOTICE file distributed with
10   *  this work for additional information regarding copyright ownership.
11   *  The ASF licenses this file to You under the Apache License, Version 2.0
12   *  (the "License"); you may not use this file except in compliance with
13   *  the License.  You may obtain a copy of the License at
14   *
15   *      http://www.apache.org/licenses/LICENSE-2.0
16   *
17   *  Unless required by applicable law or agreed to in writing, software
18   *  distributed under the License is distributed on an "AS IS" BASIS,
19   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   *  See the License for the specific language governing permissions and
21   *  limitations under the License.
22   * ====================================================================
23   *
24   * This software consists of voluntary contributions made by many
25   * individuals on behalf of the Apache Software Foundation.  For more
26   * information on the Apache Software Foundation, please see
27   * <http://www.apache.org/>.
28   *
29   */
30  
31  package org.apache.commons.httpclient;
32  
33  /***
34   * When a response stream has been consumed, various parts of the HttpClient
35   * implementation need to respond appropriately.
36   *
37   * <p>When one of the three types of {@link java.io.InputStream}, one of
38   * AutoCloseInputStream (package), {@link ContentLengthInputStream}, or
39   * {@link ChunkedInputStream} finishes with its content, either because
40   * all content has been consumed, or because it was explicitly closed,
41   * it notifies its corresponding method via this interface.</p>
42   *
43   * @see ContentLengthInputStream
44   * @see ChunkedInputStream
45   * @author Eric Johnson
46   */
47  interface ResponseConsumedWatcher {
48  
49      /***
50       * A response has been consumed.
51       */
52      void responseConsumed();
53  }