001/* 002 * ==================================================================== 003 * Licensed to the Apache Software Foundation (ASF) under one 004 * or more contributor license agreements. See the NOTICE file 005 * distributed with this work for additional information 006 * regarding copyright ownership. The ASF licenses this file 007 * to you under the Apache License, Version 2.0 (the 008 * "License"); you may not use this file except in compliance 009 * with the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, 014 * software distributed under the License is distributed on an 015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 016 * KIND, either express or implied. See the License for the 017 * specific language governing permissions and limitations 018 * under the License. 019 * ==================================================================== 020 * 021 * This software consists of voluntary contributions made by many 022 * individuals on behalf of the Apache Software Foundation. For more 023 * information on the Apache Software Foundation, please see 024 * <http://www.apache.org/>. 025 * 026 */ 027 028package org.apache.http.nio; 029 030import java.io.IOException; 031import java.nio.ByteBuffer; 032 033/** 034 * Abstract HTTP content decoder. HTTP content decoders can be used 035 * to read entity content from the underlying channel in small 036 * chunks and apply the required coding transformation. 037 * 038 * @since 4.0 039 */ 040public interface ContentDecoder { 041 042 /** 043 * Reads a portion of content from the underlying channel 044 * 045 * @param dst The buffer into which entity content is to be transferred 046 * @return The number of bytes read, possibly zero, or -1 if the 047 * channel has reached end-of-stream 048 * @throws IOException if I/O error occurs while reading content 049 */ 050 int read(ByteBuffer dst) throws IOException; 051 052 /** 053 * Returns {@code true} if the entity has been received in its 054 * entirety. 055 * 056 * @return {@code true} if all the content has been consumed, 057 * {@code false} otherwise. 058 */ 059 boolean isCompleted(); 060 061}