KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > drftpd > sections > SectionInterface


1 /*
2  * This file is part of DrFTPD, Distributed FTP Daemon.
3  *
4  * DrFTPD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * 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 JavaDoc;
21
22 import net.sf.drftpd.remotefile.LinkedRemoteFileInterface;
23
24 /**
25  * @author mog
26  * @version $Id: SectionInterface.java,v 1.3 2004/04/25 17:46:19 mog Exp $
27  */
28 public interface SectionInterface {
29
30     /**
31      * @return the (current) directory for this section
32      */
33     public LinkedRemoteFileInterface getFile();
34     /**
35      * @return all directories for this section. For example if this is a dated-dir section, it would return all dated dirs, including current dir.
36      */
37     public Collection JavaDoc getFiles();
38
39     /**
40      * @param The file/directory to return the first subdir in this section for.
41      * @return Returns the first subdirectory of the path represented that isn't the section itself.
42      * Although the returned dir can be the section itself depending on the SectionInterface implementation.
43      */
44     public LinkedRemoteFileInterface getFirstDirInSection(LinkedRemoteFileInterface dir);
45
46     /**
47      * @return The name of this section
48      */
49     public String JavaDoc getName();
50
51     /**
52      * @return getFile().getPath()
53      */
54     public String JavaDoc getPath();
55 }
56
Popular Tags