Classes in this Package | Line Coverage | Branch Coverage | Complexity | ||||||
IDirectory |
|
| 1.0;1 |
1 | /** |
|
2 | * Redistribution and use in source and binary forms, with or without |
|
3 | * modification, are permitted provided that the following conditions are |
|
4 | * met : |
|
5 | * |
|
6 | * . Redistributions of source code must retain the above copyright |
|
7 | * notice, this list of conditions and the following disclaimer. |
|
8 | * |
|
9 | * . Redistributions in binary form must reproduce the above copyright |
|
10 | * notice, this list of conditions and the following disclaimer in the |
|
11 | * documentation and/or other materials provided with the distribution. |
|
12 | * |
|
13 | * . The name of the author may not be used to endorse or promote products |
|
14 | * derived from this software without specific prior written permission. |
|
15 | * |
|
16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
|
17 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
|
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
19 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, |
|
20 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
|
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
22 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
23 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
|
24 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
25 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
|
27 | * |
|
28 | * $Id: IDirectory.java 289 2005-12-09 07:44:51Z mat007 $ |
|
29 | */ |
|
30 | ||
31 | package palmed.file; |
|
32 | ||
33 | import java.io.IOException; |
|
34 | ||
35 | /** |
|
36 | * This interface defines a file system directory. |
|
37 | * |
|
38 | * @author Mathieu Champlon |
|
39 | * @version $Revision: 289 $ $Date: 2005-12-09 16:44:51 +0900 (ven., 09 déc. 2005) $ |
|
40 | */ |
|
41 | public interface IDirectory |
|
42 | { |
|
43 | /** |
|
44 | * Select a file or sub-directory. |
|
45 | * |
|
46 | * @param filename the item name |
|
47 | * @param listener the file selection listener |
|
48 | * @return a descriptor for the item |
|
49 | */ |
|
50 | IDirectory select( String filename, IFileBrowserListener listener ); |
|
51 | ||
52 | /** |
|
53 | * Visit the current directory. |
|
54 | * |
|
55 | * @param visitor the directory visitor |
|
56 | * @throws IOException an io exception occured |
|
57 | */ |
|
58 | void accept( IDirectoryVisitor visitor ) throws IOException; |
|
59 | ||
60 | /** |
|
61 | * Test if directories or files can be created in this directory. |
|
62 | * |
|
63 | * @return whether directories or files can be created |
|
64 | */ |
|
65 | boolean isWritable(); |
|
66 | ||
67 | /** |
|
68 | * Create a sub-directory. |
|
69 | * |
|
70 | * @param name the sub-directory name |
|
71 | * @throws IOException an io exception occured |
|
72 | */ |
|
73 | void create( String name ) throws IOException; |
|
74 | ||
75 | /** |
|
76 | * Test if a given name is in the path of the directory. |
|
77 | * |
|
78 | * @param name the name to test |
|
79 | * @return whether the name is part of the path of the directory or not |
|
80 | */ |
|
81 | boolean isInPath( String name ); |
|
82 | } |