agi.foundation.time

(agi.foundation.core-2024r1.jar)

Class LeapSecond

java.lang.Object

agi.foundation.time.LeapSecond

All Implemented Interfaces:

IEquatable<LeapSecond>, ImmutableValueType, ValueType

public final class LeapSecond
extends Object
implements IEquatable<LeapSecond>, ImmutableValueType

Describes a single leap second.

The International Earth Rotation Service (IERS) periodically introduces an intercalary adjustment to the Coordinated Universal Time (UTC) time scale in order to keep it in close agreement with the Universal Time (UT1) time scale. This adjustment amounts to a one second discontinuity, a leap second, in the UTC time scale that, in addition to the UT1 time scales, also affects transformations to other continuous time scales. Since the inception of leap seconds, all adjustments have been performed either at the end of 30 June or 31 December UTC though a leap second could, by rule, be applied at the end of any month.

See Also:

LeapSecondFile

Constructor Summary

Constructors

Constructor and Description
LeapSecond() Initializes a new instance.
LeapSecond(double date, double totalTaiOffsetFromUtc) Initializes a new instance.
LeapSecond(JulianDate date, double totalTaiOffsetFromUtc) Initializes a new instance of a Leap Second.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(LeapSecond left, LeapSecond right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(LeapSecond other) Indicates whether another instance of this type is exactly equal to this instance.
JulianDate	getDate() Gets the date of the leap second.
double	getTotalTaiOffsetFromUtc() Gets the total difference TAI - UTC after this leap second, in seconds.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(LeapSecond left, LeapSecond right) Returns true if the two instances are not exactly equal.
String	toString() Returns the date of this LeapSecond and offset from UTC as a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LeapSecond

public LeapSecond()

Initializes a new instance.

LeapSecond

public LeapSecond(double date,
                  double totalTaiOffsetFromUtc)

Initializes a new instance.

Parameters:

date - The Julian date of the leap second, in Coordinated Universal Time (UTC).

totalTaiOffsetFromUtc - The offset of TAI from UTC after this leap second.

LeapSecond

public LeapSecond(@Nonnull
                  JulianDate date,
                  double totalTaiOffsetFromUtc)

Initializes a new instance of a Leap Second.

Parameters:

date - The date of the leap second. This date must be in Coordinated Universal Time (UTC).

totalTaiOffsetFromUtc - The offset of TAI from UTC after this leap second.

Throws:

ArgumentException - Thrown if the given date is not in UTC.

Method Detail

getDate

@Nonnull
public final JulianDate getDate()

Gets the date of the leap second.

getTotalTaiOffsetFromUtc

public final double getTotalTaiOffsetFromUtc()

Gets the total difference TAI - UTC after this leap second, in seconds.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                LeapSecond other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<LeapSecond>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns the date of this LeapSecond and offset from UTC as a string.

Overrides:

toString in class Object

Returns:

The string.

equals

public static boolean equals(@Nonnull
                             LeapSecond left,
                             @Nonnull
                             LeapSecond right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                LeapSecond left,
                                @Nonnull
                                LeapSecond right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.