src/de/todesbaum/util/freenet/fcp2/DiskFileEntry.java

   1 /*
   2  * todesbaum-lib -
   3  * Copyright (C) 2006 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package de.todesbaum.util.freenet.fcp2;
  21
  22 /**
  23  * A {@link FileEntry} that reads the content from a file on the disk.
  24  *
  25  * @author David Roden &lt;droden@gmail.com&gt;
  26  * @version $Id: DiskFileEntry.java 413 2006-03-29 12:22:31Z bombe $
  27  */
  28 public class DiskFileEntry extends FileEntry {
  29
  30         /** The local file name. */
  31         private final String localFilename;
  32
  33         /**
  34          * Creates a new {@link FileEntry} with the specified name and content type
  35          * that is read from the file specified by <code>localFilename</code>.
  36          *
  37          * @param filename
  38          *            The name of the file
  39          * @param contentType
  40          *            The content type of the file
  41          * @param localFilename
  42          *            The name of the local file that holds the content of the file
  43          *            to insert
  44          */
  45         public DiskFileEntry(String filename, String contentType, String localFilename) {
  46                 super(filename, contentType);
  47                 this.localFilename = localFilename;
  48         }
  49
  50         /**
  51          * {@inheritDoc}
  52          */
  53         @Override
  54         public String getName() {
  55                 return "disk";
  56         }
  57
  58         /**
  59          * Returns the name of the local file that holds the content for this file.
  60          *
  61          * @return The name of the local file
  62          */
  63         public String getLocalFilename() {
  64                 return localFilename;
  65         }
  66
  67 }