1   /* Copyright 2002-2025 CS GROUP
2    * Licensed to CS GROUP (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.orekit.time;
18  
19  import org.hipparchus.CalculusFieldElement;
20  
21  import java.io.Serializable;
22  import java.util.Comparator;
23  
24  /**
25   * Comparator for {@link FieldTimeStamped} instance.
26   *
27   * @author Luc Maisonobe
28   * @author Vincent Cucchietti
29   * @see FieldAbsoluteDate
30   * @see FieldTimeStamped
31   * @param <KK> type of the field elements
32   */
33  public class FieldChronologicalComparator<KK extends CalculusFieldElement<KK>>
34          implements Comparator<FieldTimeStamped<KK>>, Serializable {
35  
36      /** Serializable UID. */
37      private static final long serialVersionUID = -5373507372120707293L;
38  
39      /** Simple constructor. */
40      public FieldChronologicalComparator() {
41          // nothing to do
42      }
43  
44      /**
45       * Compare two time-stamped instances.
46       *
47       * @param timeStamped1 first time-stamped instance
48       * @param timeStamped2 second time-stamped instance
49       *
50       * @return a negative integer, zero, or a positive integer as the first instance is before, simultaneous, or after the
51       * second one.
52       */
53      public int compare(final FieldTimeStamped<KK> timeStamped1,
54                         final FieldTimeStamped<KK> timeStamped2) {
55          return timeStamped1.getDate().compareTo(timeStamped2.getDate());
56      }
57  }