blob: c3d9b94e1fa30a036fe8b1adef3767d9ee8e22f4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/*
* Copyright (C) 2003-2009 JNode.org
* 2009,2010 Matthias Treydte <mt@waldheinz.de>
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; If not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package de.waldheinz.fs;
import java.io.IOException;
import java.util.Iterator;
/**
* Base class for all {@link FileSystem} directories.
*
* @author Ewout Prangsma < epr at jnode.org>
* @author Matthias Treydte
*/
public interface FsDirectory extends Iterable<FsDirectoryEntry>, FsObject {
/**
* Gets an iterator to iterate over the entries of this directory.
*
* @return the directory iterator
*/
@Override
public Iterator<FsDirectoryEntry> iterator();
/**
* Gets the entry with the given name.
*
* @param name the name of the entry to get
* @return the entry, if it existed
* @throws IOException on error retrieving the entry
*/
public FsDirectoryEntry getEntry(String name) throws IOException;
/**
* Add a new file with a given name to this directory.
*
* @param name the name of the file to add
* @return the entry pointing to the new file
* @throws IOException on error creating the file
*/
public FsDirectoryEntry addFile(String name) throws IOException;
/**
* Add a new (sub-)directory with a given name to this directory.
*
* @param name the name of the sub-directory to add
* @return the entry pointing to the new directory
* @throws IOException on error creating the directory
*/
public FsDirectoryEntry addDirectory(String name) throws IOException;
/**
* Remove the entry with the given name from this directory.
*
* @param name name of the entry to remove
* @throws IOException on error deleting the entry
*/
public void remove(String name) throws IOException;
/**
* Save all dirty (unsaved) data to the device.
*
* @throws IOException on write error
*/
public void flush() throws IOException;
}
|