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 java.io.File;
41 import javax.swing.filechooser.FileFilter;
42 import org.apache.commons.io.FilenameUtils;
43
44 /**
45 * The ARCFileFilter class is used to choose a TINKER Archive (*.ARC).
46 *
47 * @author Michael J. Schnieders
48 * @since 1.0
49 */
50 public final class ARCFileFilter extends FileFilter {
51
52 /** Default Constructor */
53 public ARCFileFilter() {
54 }
55
56 /**
57 * This is a static version of the accept method.
58 *
59 * <p>This method return <code>true</code> if the file is a directory or TINKER Archive (*.ARC).
60 *
61 * @param file The File to examine.
62 * @return Returns true if this an ARC file.
63 */
64 public static boolean isARC(File file) {
65 return new ARCFileFilter().accept(file);
66 }
67
68 /**
69 * {@inheritDoc}
70 *
71 * <p>This method return <code>true</code> if the file is a directory or TINKER Archive (*.ARC).
72 */
73 @Override
74 public boolean accept(File file) {
75 if (file.isDirectory()) {
76 return true;
77 }
78 String ext = FilenameUtils.getExtension(file.getName());
79 return ext.toUpperCase().startsWith("ARC");
80 }
81
82 /**
83 * {@inheritDoc}
84 *
85 * <p>Provides a description of this FileFilter
86 */
87 @Override
88 public String getDescription() {
89 return "TINKER Archive (*.ARC)";
90 }
91 }