KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jorm > util > io > api > PathExplorer


1 /**
2  * JORM: an implementation of a generic mapping system for persistent Java
3  * objects. Two mapping are supported: to RDBMS and to binary files.
4  * Copyright (C) 2001-2003 France Telecom R&D - INRIA
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  * Contact: jorm-team@objectweb.org
21  *
22  */

23
24 package org.objectweb.jorm.util.io.api;
25
26 import java.util.Collection JavaDoc;
27 import java.io.InputStream JavaDoc;
28 import java.io.OutputStream JavaDoc;
29
30 /**
31  * PathExplorer interface defines methods to create object able
32  * to manage a list of paths and furnish input and output stream
33  * on files
34  */

35 public interface PathExplorer {
36
37     /**
38      * adds a classpath and its path separator to the current explorer.
39      * This classpath is added to the list of path already defines.
40      * @param cpath the classpath which contains a list of paths
41      */

42     void addPath(String JavaDoc cpath);
43
44     /**
45      * creates the paths with the given path
46      * @param path the vector of paths (which are String).
47      */

48     void addPath(Collection JavaDoc path);
49
50     /**
51      * gets an input stream from a given file. This file is opened from the
52      * defined path.
53      * @param file the string representation of the name of the file
54      * @return an InputStream for the given file
55      */

56     InputStream JavaDoc getInputStream(String JavaDoc file);
57
58     /**
59      * gets an output stream from a given file. This file is opened from the
60      * defined path.
61      * @param file the string representation of the name of the file
62      * @return an OutputStream for the given file
63      */

64     OutputStream JavaDoc getOutputStream(String JavaDoc file);
65
66
67     String JavaDoc getClassPath();
68
69 }
70
Popular Tags