View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.core.file;
21  
22  import java.io.File;
23  import java.io.IOException;
24  import java.nio.channels.FileChannel;
25  
26  /**
27   * Manage a File to be sent to a remote host. We keep a track on the current
28   * position, and the number of already written bytes.
29   * 
30   * @author The Apache MINA Project (dev@mina.apache.org)
31   * @version $Rev$, $Date$
32   */
33  public class FilenameFileRegion extends DefaultFileRegion {
34  
35      private final File file;
36  
37      /**
38       * Create a new FilenameFileRegion instance
39       * 
40       * @param file The file to manage
41       * @param channel The channel over the file
42       */
43      public FilenameFileRegion(File file, FileChannel channel) {
44          this(file, channel, 0, file.length());
45      }
46  
47      /**
48       * Create a new FilenameFileRegion instance
49       * 
50       * @param file The file to manage
51       * @param channel The channel over the file
52       * @param position The position in teh file
53       * @param remainingBytes The remaining bytes
54       */
55      public FilenameFileRegion(File file, FileChannel channel, long position, long remainingBytes) {
56          super(channel, position, remainingBytes);
57  
58          if (file == null) {
59              throw new IllegalArgumentException("file can not be null");
60          }
61          
62          this.file = file;
63      }
64  
65      /**
66       * {@inheritDoc}
67       */
68      @Override
69      public String getFilename() {
70          return file.getAbsolutePath();
71      }
72  }