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.parameters;
39
40 import ffx.potential.parameters.ForceField.ForceFieldType;
41 import java.util.logging.Level;
42 import java.util.logging.Logger;
43
44 /**
45 * All force field types should extend the BaseType class.
46 *
47 * @author Michael J. Schnieders
48 * @since 1.0
49 */
50 public abstract class BaseType {
51
52 private static final Logger logger = Logger.getLogger(BaseType.class.getName());
53 /**
54 * The look-up key for this term, which is usually a concatenation of atom classes or atom types.
55 */
56 protected String key;
57 /** The ForceFieldType of this term. */
58 ForceFieldType forceFieldType;
59
60 /**
61 * Public constructor.
62 *
63 * @param forceFieldType a {@link ffx.potential.parameters.ForceField.ForceFieldType} object.
64 * @param keys an array of int.
65 * @since 1.0
66 */
67 public BaseType(ForceFieldType forceFieldType, int[] keys) {
68 this.forceFieldType = forceFieldType;
69 setKey(keys);
70 }
71
72 /**
73 * Public constructor.
74 *
75 * @param forceFieldType a {@link ffx.potential.parameters.ForceField.ForceFieldType} object.
76 * @param key a {@link java.lang.String} object.
77 * @since 1.0
78 */
79 public BaseType(ForceFieldType forceFieldType, String key) {
80 this.forceFieldType = forceFieldType;
81 this.key = key;
82 }
83
84 /**
85 * Get the <code>key</code> for this Type.
86 *
87 * @return the key
88 * @since 1.0
89 */
90 public String getKey() {
91 return key;
92 }
93
94 /**
95 * Setter for the field <code>key</code>.
96 *
97 * @param keys an array of int.
98 */
99 public void setKey(int[] keys) {
100 if (keys == null) {
101 key = null;
102 return;
103 }
104
105 StringBuilder keyBuffer = new StringBuilder();
106 for (int k : keys) {
107 keyBuffer.append(k);
108 keyBuffer.append(" ");
109 }
110 key = keyBuffer.toString().trim();
111 }
112
113 /**
114 * Setter for the field <code>key</code>.
115 *
116 * @param key a {@link java.lang.String} object.
117 */
118 public void setKey(String key) {
119 this.key = key;
120 }
121
122 /**
123 * Log <code>this</code> type.
124 *
125 * @since 1.0
126 */
127 public void log() {
128 if (logger.isLoggable(Level.INFO)) {
129 logger.info(toString());
130 }
131 }
132
133 /**
134 * Print <code>this</code> to System.out.
135 *
136 * @since 1.0
137 */
138 public void print() {
139 System.out.println(this);
140 }
141
142 /**
143 * {@inheritDoc}
144 *
145 * <p>Basic toString method.
146 *
147 * @since 1.0
148 */
149 @Override
150 public String toString() {
151 return forceFieldType + " " + key;
152 }
153 }