01: /* ====================================================================
02: The Jicarilla Software License
03:
04: Copyright (c) 2003 Leo Simons.
05: All rights reserved.
06:
07: Permission is hereby granted, free of charge, to any person obtaining
08: a copy of this software and associated documentation files (the
09: "Software"), to deal in the Software without restriction, including
10: without limitation the rights to use, copy, modify, merge, publish,
11: distribute, sublicense, and/or sell copies of the Software, and to
12: permit persons to whom the Software is furnished to do so, subject to
13: the following conditions:
14:
15: The above copyright notice and this permission notice shall be
16: included in all copies or substantial portions of the Software.
17:
18: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21: IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23: TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24: SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25: ==================================================================== */
26: package org.jicarilla.io;
27:
28: import java.io.FileNotFoundException;
29: import java.nio.channels.ReadableByteChannel;
30:
31: /**
32: *
33: *
34: * @author <a href="lsimons at jicarilla dot org">Leo Simons</a>
35: * @version $Id: Filesystem.java,v 1.3 2004/03/31 12:10:58 lsimons Exp $
36: */
37: public interface Filesystem {
38: /**
39: * Retrieve a file from the filesystem for reading.
40: *
41: * @param relativePath the path to the file relative to the filesystem
42: * root.
43: * @return a channel which points to the contents of the file.
44: * @throws FileNotFoundException if the specified file cannot be found,
45: * the provided path points to a directory or to a file from which
46: * cannot be read.
47: * @throws SecurityException if there is a security manager present and it
48: * denies access to the specified file.
49: */
50: ReadableByteChannel getFile(String relativePath)
51: throws FileNotFoundException;
52:
53: /**
54: * Return a file to the filesystem after reading.
55: *
56: * @param channel the channel that was retrieved through
57: * {@link #getFile(String)}.
58: */
59: void returnFile(ReadableByteChannel channel);
60: }
|