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.utilities;
39
40 import java.util.ArrayList;
41 import java.util.List;
42
43 /**
44 * ObjectPair record.
45 * <p>
46 * Implements a comparable pair, where a non-comparable T can be compared via a comparable S.
47 *
48 * @param <T> The class of the non-comparable object.
49 * @param <S> The class of the indexing, comparable object.
50 * @param val The non-comparable object.
51 * @param key The indexing, comparable object.
52 * @author Jacob Litman
53 * @since 1.0
54 */
55 public record ObjectPair<T, S extends Comparable<S>>(T val, S key) implements Comparable<ObjectPair<T, S>> {
56
57 /**
58 * sortAndReturn.
59 *
60 * @param theList a {@link List} object.
61 * @param <U> Some object.
62 * @param <V> Some indexing, comparable object
63 * @return the sorted {@link List} of objects.
64 */
65 public static <U, V extends Comparable<V>> List<U> sortAndReturn(List<ObjectPair<U, V>> theList) {
66 theList.sort(null);
67 List<U> retList = new ArrayList<>(theList.size());
68 for (ObjectPair<U, V> e : theList) {
69 retList.add(e.val());
70 }
71 return retList;
72 }
73
74 /**
75 * {@inheritDoc}
76 */
77 @Override
78 public int compareTo(ObjectPair<T, S> o) {
79 return key.compareTo(o.key());
80 }
81
82 }