fr.cnes.sirius.patrius.time

Class ChronologicalComparator

java.lang.Object

fr.cnes.sirius.patrius.time.ChronologicalComparator

All Implemented Interfaces:

Serializable, Comparator<TimeStamped>

public class ChronologicalComparator
extends Object
implements Comparator<TimeStamped>, Serializable

Comparator for TimeStamped instance.

null is not an accepted value for generic ChronologicalComparator. In order to handle null values, a null-compliant comparator should be built with one of the following methods:

• Comparator.nullsFirst(new ChronologicalComparator()): null values being set first
• Comparator.nullsLast(new ChronologicalComparator()): null values being set last

Author:

Luc Maisonobe

See Also:

AbsoluteDate, TimeStamped, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChronologicalComparator()

Method Summary

Modifier and Type	Method and Description
int	compare(TimeStamped timeStamped1, TimeStamped timeStamped2) Compare two time-stamped instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

ChronologicalComparator

public ChronologicalComparator()

Method Detail

compare

public int compare(TimeStamped timeStamped1,
                   TimeStamped timeStamped2)

Compare two time-stamped instances.

Specified by:

compare in interface Comparator<TimeStamped>

Parameters:

timeStamped1 - first time-stamped instance

timeStamped2 - second time-stamped instance

Returns:

a negative integer, zero, or a positive integer as the first instance is before, simultaneous, or after the second one.