src/net/pterodactylus/jsite/core/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
  20 package net.pterodactylus.jsite.core;
  21
  22 import java.io.File;
  23 import java.util.List;
  24
  25
  26 /**
  27  * Abstraction for a that exists on the machine {@link Core} is being run on.
  28  * This abstraction layer exists to make it possible to run jSite as a daemon
  29  * and only connect to it via network.
  30  *
  31  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  32  */
  33 public interface ProjectFile {
  34
  35         /**
  36          * Returns the name of the file.
  37          *
  38          * @return The name of the file
  39          */
  40         public String getName();
  41
  42         /**
  43          * Returns the parent of this project file.
  44          *
  45          * @return The parent of this project file, or <code>null</code> if this
  46          *         project file does not have a parent
  47          */
  48         public ProjectFile getParent();
  49
  50         /**
  51          * Returns all parent files of this file. This file is the last file in the
  52          * returned list.
  53          *
  54          * @return A list of all parents of this file and this file itself
  55          */
  56         public List<ProjectFile> getParents();
  57
  58         /**
  59          * Returns the complete path of this file, without a leading
  60          * {@link File#separator}.
  61          *
  62          * @return The complete path of this file
  63          */
  64         public String getCompletePath();
  65
  66         /**
  67          * Returns the size of the file. If this file is a directory, the returned
  68          * value is unspecified.
  69          *
  70          * @see File#length()
  71          * @return The size of the file
  72          */
  73         public long getSize();
  74
  75         /**
  76          * Returns whether this file is a directory.
  77          *
  78          * @return <code>true</code> if this file is a directory,
  79          *         <code>false</code> otherwise
  80          */
  81         public boolean isDirectory();
  82
  83         /**
  84          * Returns whether this file is a file (as opposed to being a directory).
  85          *
  86          * @return <code>true</code> if this file is a file, <code>false</code>
  87          *         otherwise
  88          */
  89         public boolean isFile();
  90
  91         /**
  92          * Returns whether this file is hidden.
  93          *
  94          * @return <code>true</code> if this file is hidden
  95          */
  96         public boolean isHidden();
  97
  98         /**
  99          * If this file is a directory, returns all files in this directory.
 100          *
 101          * @see #isDirectory()
 102          * @return All files in this directory if this file is a directory, or
 103          *         <code>null</code> if this file is not a directory
 104          */
 105         public List<ProjectFile> getFiles();
 106
 107 }