2 * jSite2 - ProjectFile.java -
3 * Copyright © 2008 David Roden
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.
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.
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.
20 package net.pterodactylus.jsite.core;
23 import java.util.List;
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.
31 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
33 public interface ProjectFile {
36 * Returns the name of the file.
38 * @return The name of the file
40 public String getName();
43 * Returns the parent of this project file.
45 * @return The parent of this project file, or <code>null</code> if this
46 * project file does not have a parent
48 public ProjectFile getParent();
51 * Returns all parent files of this file. This file is the last file in the
54 * @return A list of all parents of this file and this file itself
56 public List<ProjectFile> getParents();
59 * Returns the complete path of this file, without a leading
60 * {@link File#separator}.
62 * @return The complete path of this file
64 public String getCompletePath();
67 * Returns the size of the file. If this file is a directory, the returned
68 * value is unspecified.
71 * @return The size of the file
73 public long getSize();
76 * Returns whether this file is a directory.
78 * @return <code>true</code> if this file is a directory,
79 * <code>false</code> otherwise
81 public boolean isDirectory();
84 * Returns whether this file is a file (as opposed to being a directory).
86 * @return <code>true</code> if this file is a file, <code>false</code>
89 public boolean isFile();
92 * Returns whether this file is hidden.
94 * @return <code>true</code> if this file is hidden
96 public boolean isHidden();
99 * If this file is a directory, returns all files in this directory.
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
105 public List<ProjectFile> getFiles();