1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.potential.parsers;
39
40 import ffx.potential.MolecularAssembly;
41 import org.apache.commons.configuration2.CompositeConfiguration;
42
43 /**
44 * The FileOpener interface specifies Runnable objects which can return one or more
45 * MolecularAssemblies. Implementing classes should not be constructed except by a class
46 * implementing PotentialsFunctions; one should pass that class the File to be opened, which
47 * constructs an implementation of FileOpener.
48 *
49 * <p>To some extent, this interface is legacy code of when I was trying to implement the open()
50 * methods from MainPanel instead of openWait(); it should be possible to simply wrap the methods
51 * into the classes implementing PotentialsFunctions.
52 *
53 * @author Jacob M. Litman
54 * @author Michael J. Schnieders
55 */
56 public interface FileOpener extends Runnable {
57
58 /**
59 * getAllAssemblies.
60 *
61 * @return an array of {@link ffx.potential.MolecularAssembly} objects.
62 */
63 MolecularAssembly[] getAllAssemblies();
64
65 /**
66 * getAllProperties.
67 *
68 * @return an array of {@link org.apache.commons.configuration2.CompositeConfiguration} objects.
69 */
70 CompositeConfiguration[] getAllProperties();
71
72 /**
73 * getAssembly.
74 *
75 * @return a {@link ffx.potential.MolecularAssembly} object.
76 */
77 MolecularAssembly getAssembly();
78
79 /**
80 * getProperties.
81 *
82 * @return a {@link org.apache.commons.configuration2.CompositeConfiguration} object.
83 */
84 CompositeConfiguration getProperties();
85
86 /** {@inheritDoc} */
87 @Override
88 void run();
89 }