1 package org.molwind.io;
2
3 /*
4 * This file is part of Molwind.
5 *
6 * Molwind is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * Molwind 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
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with Molwind. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 import java.io.IOException;
21
22 import org.molwind.model.MolwindWorld;
23
24 /**
25 * WorldLocator implementations locate the data to build up molecular worlds.
26 *
27 * @author <a href="mailto:oliver.karch@molwind.org">Oliver Karch</a>
28 * @version 1.0
29 */
30
31
32 public interface WorldLocator {
33 /**
34 * Returns a (possibly empty) list of locatable worlds
35 *
36 * @return
37 * an array of world names
38 */
39
40 public String[] getWorldNames();
41
42
43 /**
44 * Locates a world with the given name.
45 *
46 * @param worldName
47 * the name of the world
48 * @return
49 * a molwind world descriptor
50 * @throws java.io.IOException
51 * is thrown upon i/o error
52 */
53 MolwindWorld locateWorld(String worldName)
54 throws IOException;
55
56 }