View Javadoc

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