01: /*
02: * This file is part of DrFTPD, Distributed FTP Daemon.
03: *
04: * DrFTPD is free software; you can redistribute it and/or modify
05: * it under the terms of the GNU General Public License as published by
06: * the Free Software Foundation; either version 2 of the License, or
07: * (at your option) any later version.
08: *
09: * DrFTPD is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: * GNU General Public License for more details.
13: *
14: * You should have received a copy of the GNU General Public License
15: * along with DrFTPD; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18: package org.drftpd.sections;
19:
20: import java.util.Collection;
21:
22: import org.drftpd.remotefile.LinkedRemoteFileInterface;
23:
24: /**
25: * @author mog
26: * @version $Id: SectionInterface.java 847 2004-12-02 03:32:41Z mog $
27: */
28: public interface SectionInterface {
29: /**
30: * @return the base directory for this section.
31: */
32: public LinkedRemoteFileInterface getBaseFile();
33:
34: /**
35: * @return the (current) directory for this section.
36: */
37: public LinkedRemoteFileInterface getFile();
38:
39: public String getBasePath();
40:
41: /**
42: * @return all directories for this section. For example if this is a dated-dir section, it would return all dated dirs, including current dir.
43: */
44: public Collection getFiles();
45:
46: /**
47: * @param The file/directory to return the first subdir in this section for.
48: * @return Returns the first subdirectory of the path represented that isn't the section itself.
49: * Although the returned dir can be the section itself depending on the SectionInterface implementation.
50: */
51: public LinkedRemoteFileInterface getFirstDirInSection(
52: LinkedRemoteFileInterface dir);
53:
54: /**
55: * @return The name of this section
56: */
57: public String getName();
58:
59: /**
60: * @return getFile().getPath()
61: */
62: public String getPath();
63: }
|