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