src/net/pterodactylus/jsite/project/Entry.java

   1 /*
   2  * jSite2 - Entry.java -
   3  * Copyright © 2008 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 net.pterodactylus.jsite.project;
  21
  22 /**
  23  * A file is an entry in a directory. Its name can contain multiple components
  24  * (separated by a slash, ‘/’).
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public interface Entry {
  29
  30         /**
  31          * Returns the name of the file. The name can contain multiple path
  32          * components, separated by a slash (‘/’). It will never start with a slash,
  33          * though.
  34          *
  35          * @return The name of the file
  36          */
  37         public String getName();
  38
  39         /**
  40          * Sets the name of the file.
  41          *
  42          * @param name
  43          *            The name of the file
  44          */
  45         public void setName(String name);
  46
  47         /**
  48          * Returns whether this file should be inserted.
  49          *
  50          * @return <code>true</code> to insert the file, <code>false</code> to
  51          *         skip it
  52          */
  53         public boolean isInsert();
  54
  55         /**
  56          * Sets whether this file should be inserted.
  57          *
  58          * @param insert
  59          *            <code>true</code> to insert the file, <code>false</code>
  60          *            to skip it
  61          */
  62         public void setInsert(boolean insert);
  63
  64         /**
  65          * Returns the content type of the file. If the content type is
  66          * <code>null</code>, the node will auto-detect the content type based on
  67          * the filename. The content type is given as a MIME type.
  68          *
  69          * @return The content of the file
  70          */
  71         public String getContentType();
  72
  73         /**
  74          * Sets the content type of the file.
  75          *
  76          * @param contentType
  77          *            The content type of the file
  78          */
  79         public void setContentType(String contentType);
  80
  81 }