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.nio;
29
30 import java.io.IOException;
31 import java.nio.ByteBuffer;
32
33 /**
34 * Abstract HTTP content decoder. HTTP content decoders can be used
35 * to read entity content from the underlying channel in small
36 * chunks and apply the required coding transformation.
37 *
38 * @since 4.0
39 */
40 public interface ContentDecoder {
41
42 /**
43 * Reads a portion of content from the underlying channel
44 *
45 * @param dst The buffer into which entity content is to be transferred
46 * @return The number of bytes read, possibly zero, or -1 if the
47 * channel has reached end-of-stream
48 * @throws IOException if I/O error occurs while reading content
49 */
50 int read(ByteBuffer dst) throws IOException;
51
52 /**
53 * Returns {@code true} if the entity has been received in its
54 * entirety.
55 *
56 * @return {@code true} if all the content has been consumed,
57 * {@code false} otherwise.
58 */
59 boolean isCompleted();
60
61 }