9b3c52126b0a878e9ee0b4a5881c59336722e905
[jSite2.git] / 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 import java.io.File;
23
24 /**
25  * A file is an entry in a directory. Its name can contain multiple components,
26  * separated by the platform’s {@link File#separatorChar}.
27  * 
28  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
29  */
30 public interface Entry {
31
32         /**
33          * Returns whether this entry denotes a virtual file. A virtual file entry
34          * is a file entry that does not have a corresponding file on the disk.
35          * 
36          * @return <code>true</code> if this entry is a virtual file entry,
37          *         <code>false</code> otherwise
38          */
39         public boolean isVirtual();
40
41         /**
42          * Returns the name of the file. The name can contain multiple path
43          * components, separated by the platform’s {@link File#separatorChar}. It
44          * will never start with a separator, though.
45          * 
46          * @return The name of the file
47          */
48         public String getName();
49
50         /**
51          * Sets the name of the file.
52          * 
53          * @param name
54          *            The name of the file
55          */
56         public void setName(String name);
57
58         /**
59          * Returns whether this file should be inserted.
60          * 
61          * @return <code>true</code> to insert the file, <code>false</code> to
62          *         skip it
63          */
64         public boolean isInsert();
65
66         /**
67          * Sets whether this file should be inserted.
68          * 
69          * @param insert
70          *            <code>true</code> to insert the file, <code>false</code>
71          *            to skip it
72          */
73         public void setInsert(boolean insert);
74
75         /**
76          * Returns the content type of the file. If the content type is
77          * <code>null</code>, the node will auto-detect the content type based on
78          * the filename. The content type is given as a MIME type.
79          * 
80          * @return The content of the file
81          */
82         public String getContentType();
83
84         /**
85          * Sets the content type of the file.
86          * 
87          * @param contentType
88          *            The content type of the file
89          */
90         public void setContentType(String contentType);
91
92 }