Save This Page
1 /*
2 * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/httpcore/tags/4.0.1/httpcore-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java $
3 * $Revision: 744541 $
4 * $Date: 2009-02-14 18:26:23 +0100 (Sat, 14 Feb 2009) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements. See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership. The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with 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,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied. See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation. For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32 package org.apache.http.nio;
33
34 import java.io.IOException;
35 import java.nio.channels.FileChannel;
36
37 /**
38 * A content decoder capable of transferring data directly to a {@link FileChannel}
39 *
40 * @since 4.0
41 */
42 public interface FileContentDecoder extends ContentDecoder {
43
44 /**
45 * Transfers a portion of entity content from the underlying network channel
46 * into the given file channel.<br>
47 *
48 * <b>Warning</b>: Many implementations cannot write beyond the length of the file.
49 * If the position exceeds the channel's size, some implementations
50 * may throw an IOException.
51 *
52 * @param dst the target FileChannel to transfer data into.
53 * @param position
54 * The position within the file at which the transfer is to begin;
55 * must be non-negative.
56 * <b>Must be less than or equal to the size of the file</b>
57 * @param count
58 * The maximum number of bytes to be transferred; must be
59 * non-negative
60 * @throws IOException, if some I/O error occurs.
61 * @return The number of bytes, possibly zero,
62 * that were actually transferred
63 */
64 long transfer(FileChannel dst, long position, long count) throws IOException;
65
66 }