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.nio.channels.FileChannel;
24  
25  /**
26   * Manage a File to be sent to a remote host. We keep a track on the current
27   * position, and the number of already written bytes.
28   * 
29   * @author The Apache MINA Project (dev@mina.apache.org)
30   * @version $Rev$, $Date$
31   */
32  public class FilenameFileRegion extends DefaultFileRegion {
33  
34      private final File file;
35  
36      /**
37       * Create a new FilenameFileRegion instance
38       * 
39       * @param file The file to manage
40       * @param channel The channel over the file
41       */
42      public FilenameFileRegion(File file, FileChannel channel) {
43          this(file, channel, 0, file.length());
44      }
45  
46      /**
47       * Create a new FilenameFileRegion instance
48       * 
49       * @param file The file to manage
50       * @param channel The channel over the file
51       * @param position The position in teh file
52       * @param remainingBytes The remaining bytes
53       */
54      public FilenameFileRegion(File file, FileChannel channel, long position, long remainingBytes) {
55          super(channel, position, remainingBytes);
56  
57          if (file == null) {
58              throw new IllegalArgumentException("file can not be null");
59          }
60          
61          this.file = file;
62      }
63  
64      /**
65       * {@inheritDoc}
66       */
67      @Override
68      public String getFilename() {
69          return file.getAbsolutePath();
70      }
71  }