+++ /dev/null
-/*
- * jSite2 - ProjectFile.java -
- * Copyright © 2008 David Roden
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- */
-
-package net.pterodactylus.jsite.core.project;
-
-import java.io.File;
-import java.util.List;
-
-import net.pterodactylus.jsite.core.Core;
-
-/**
- * Abstraction for a that exists on the machine {@link Core} is being run on.
- * This abstraction layer exists to make it possible to run jSite as a daemon
- * and only connect to it via network.
- *
- * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- */
-public interface ProjectFile {
-
- /**
- * Returns the name of the file.
- *
- * @return The name of the file
- */
- public String getName();
-
- /**
- * Returns the parent of this project file.
- *
- * @return The parent of this project file, or <code>null</code> if this
- * project file does not have a parent
- */
- public ProjectFile getParent();
-
- /**
- * Returns all parent files of this file. This file is the last file in the
- * returned list.
- *
- * @return A list of all parents of this file and this file itself
- */
- public List<ProjectFile> getParents();
-
- /**
- * Returns the complete path of this file, without a leading
- * {@link File#separator}.
- *
- * @return The complete path of this file
- */
- public String getCompletePath();
-
- /**
- * Returns the size of the file. If this file is a directory, the returned
- * value is unspecified.
- *
- * @see File#length()
- * @return The size of the file
- */
- public long getSize();
-
- /**
- * Returns whether this file is a directory.
- *
- * @return <code>true</code> if this file is a directory,
- * <code>false</code> otherwise
- */
- public boolean isDirectory();
-
- /**
- * Returns whether this file is a file (as opposed to being a directory).
- *
- * @return <code>true</code> if this file is a file, <code>false</code>
- * otherwise
- */
- public boolean isFile();
-
- /**
- * Returns whether this file is hidden.
- *
- * @return <code>true</code> if this file is hidden
- */
- public boolean isHidden();
-
- /**
- * If this file is a directory, returns all files in this directory.
- *
- * @see #isDirectory()
- * @return All files in this directory if this file is a directory, or
- * <code>null</code> if this file is not a directory
- */
- public List<ProjectFile> getFiles();
-
-}