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

   1 /*
   2  * jSite2 - ProjectFile.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 package net.pterodactylus.jsite.project;
  20
  21 import java.util.List;
  22
  23 import net.pterodactylus.jsite.core.Core;
  24
  25 /**
  26  * Abstraction for a that exists on the machine {@link Core} is being run on.
  27  * This abstraction layer exists to make it possible to run jSite as a daemon
  28  * and only connect to it via network.
  29  *
  30  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  31  */
  32 public interface ProjectFile {
  33
  34         /**
  35          * Returns the name of the file.
  36          *
  37          * @return The name of the file
  38          */
  39         public String getName();
  40
  41         /**
  42          * Returns all parent files of this file. This file is the last file in the
  43          * returned list.
  44          *
  45          * @return A list of all parents of this file and this file itself
  46          */
  47         public List<ProjectFile> getParents();
  48
  49         /**
  50          * Returns whether this file is a directory.
  51          *
  52          * @return <code>true</code> if this file is a directory,
  53          *         <code>false</code> otherwise
  54          */
  55         public boolean isDirectory();
  56
  57         /**
  58          * Returns whether this file is a file (as opposed to being a directory).
  59          *
  60          * @return <code>true</code> if this file is a file, <code>false</code>
  61          *         otherwise
  62          */
  63         public boolean isFile();
  64
  65         /**
  66          * Returns whether this file is hidden.
  67          *
  68          * @return <code>true</code> if this file is hidden
  69          */
  70         public boolean isHidden();
  71
  72         /**
  73          * If this file is a directory, returns all files in this directory.
  74          *
  75          * @see #isDirectory()
  76          * @return All files in this directory if this file is a directory, or
  77          *         <code>null</code> if this file is not a directory
  78          */
  79         public List<ProjectFile> getFiles();
  80
  81 }